blob: d3a0130cb3e65f85540ecfc5f081c144efcb2603 [file] [log] [blame]
Joey Armstrong2c039362024-02-04 18:51:52 -05001# Copyright 2018-2024 Open Networking Foundation (ONF) and the ONF Contributors
Matteo Scandolo9f619492019-10-25 13:11:58 -07002
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6
7# http://www.apache.org/licenses/LICENSE-2.0
8
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15# -*- coding: utf-8 -*-
16#
17# Configuration file for the Sphinx documentation builder.
18#
19# This file does only contain a selection of the most common options. For a
20# full list see the documentation:
21# http://www.sphinx-doc.org/en/master/config
22
23# -- Path setup --------------------------------------------------------------
24
25# If extensions (or modules to document with autodoc) are in another directory,
26# add these directories to sys.path here. If the directory is relative to the
27# documentation root, use os.path.abspath to make it absolute, like shown here.
28#
29# import os
30# import sys
31# sys.path.insert(0, os.path.abspath('.'))
32
33
34# -- Project information -----------------------------------------------------
35
36project = u'BBSim'
Joey Armstrong4d6878e2024-02-08 16:29:26 -050037Copyright 2019-2024 Open Networking Foundation (ONF) and the ONF Contributors
Matteo Scandolo9f619492019-10-25 13:11:58 -070038author = u'Open Networking Foundation'
39
40# The short X.Y version
41version = u''
42# The full version, including alpha/beta/rc tags
43release = u''
44
45
46# -- General configuration ---------------------------------------------------
47
48# If your documentation needs a minimal Sphinx version, state it here.
49#
50# needs_sphinx = '1.0'
51
52# Add any Sphinx extension module names here, as strings. They can be
53# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
54# ones.
55extensions = [
Zdravko Bozakov2da76342019-10-21 09:47:35 +020056 'sphinxcontrib.openapi',
Matteo Scandolof380a972020-09-11 12:09:40 -070057 'sphinx.ext.graphviz',
Matteo Scandolo9f619492019-10-25 13:11:58 -070058]
59
60# Add any paths that contain templates here, relative to this directory.
61templates_path = ['_templates']
62
63# The suffix(es) of source filenames.
64# You can specify multiple suffix as a list of string:
65#
66# source_suffix = ['.rst', '.md']
67source_suffix = '.rst'
68
69# The master toctree document.
70master_doc = 'index'
71
72# The language for content autogenerated by Sphinx. Refer to documentation
73# for a list of supported languages.
74#
75# This is also used if you do content translation via gettext catalogs.
76# Usually you set "language" from the command line for these cases.
77language = None
78
79# List of patterns, relative to source directory, that match files and
80# directories to ignore when looking for source files.
81# This pattern also affects html_static_path and html_extra_path.
82exclude_patterns = []
83
84# The name of the Pygments (syntax highlighting) style to use.
85pygments_style = None
86
87
88# -- Options for HTML output -------------------------------------------------
89
90# The theme to use for HTML and HTML Help pages. See the documentation for
91# a list of builtin themes.
92#
93html_theme = 'alabaster'
94
95# Theme options are theme-specific and customize the look and feel of a theme
96# further. For a list of options available for each theme, see the
97# documentation.
98#
99# html_theme_options = {}
100
101# Add any paths that contain custom static files (such as style sheets) here,
102# relative to this directory. They are copied after the builtin static files,
103# so a file named "default.css" will overwrite the builtin "default.css".
104html_static_path = ['_static']
105
106# Custom sidebar templates, must be a dictionary that maps document names
107# to template names.
108#
109# The default sidebars (for documents that don't match any pattern) are
110# defined by theme itself. Builtin themes are using these templates by
111# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
112# 'searchbox.html']``.
113#
114# html_sidebars = {}
115
116
117# -- Options for HTMLHelp output ---------------------------------------------
118
119# Output file base name for HTML help builder.
120htmlhelp_basename = 'BBSimdoc'
121
122
123# -- Options for LaTeX output ------------------------------------------------
124
125latex_elements = {
126 # The paper size ('letterpaper' or 'a4paper').
127 #
128 # 'papersize': 'letterpaper',
129
130 # The font size ('10pt', '11pt' or '12pt').
131 #
132 # 'pointsize': '10pt',
133
134 # Additional stuff for the LaTeX preamble.
135 #
136 # 'preamble': '',
137
138 # Latex figure (float) alignment
139 #
140 # 'figure_align': 'htbp',
141}
142
143# Grouping the document tree into LaTeX files. List of tuples
144# (source start file, target name, title,
145# author, documentclass [howto, manual, or own class]).
146latex_documents = [
147 (master_doc, 'BBSim.tex', u'BBSim Documentation',
148 u'Open Networking Foundation', 'manual'),
149]
150
151
152# -- Options for manual page output ------------------------------------------
153
154# One entry per manual page. List of tuples
155# (source start file, name, description, authors, manual section).
156man_pages = [
157 (master_doc, 'bbsim', u'BBSim Documentation',
158 [author], 1)
159]
160
161
162# -- Options for Texinfo output ----------------------------------------------
163
164# Grouping the document tree into Texinfo files. List of tuples
165# (source start file, target name, title, author,
166# dir menu entry, description, category)
167texinfo_documents = [
168 (master_doc, 'BBSim', u'BBSim Documentation',
169 author, 'BBSim', 'One line description of project.',
170 'Miscellaneous'),
171]
172
173
174# -- Options for Epub output -------------------------------------------------
175
176# Bibliographic Dublin Core info.
177epub_title = project
178
179# The unique identifier of the text. This can be a ISBN number
180# or the project homepage.
181#
182# epub_identifier = ''
183
184# A unique identification for the text.
185#
186# epub_uid = ''
187
188# A list of files that should not be packed into the epub file.
189epub_exclude_files = ['search.html']