Debian Codegraph @

doc/conf.py

raw
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3 #
4 # Flent: The FLExible Network Tester documentation build configuration file, created by
5 # sphinx-quickstart on Fri May 29 22:12:32 2015.
6 #
7 # This file is execfile()d with the current directory set to its
8 # containing dir.
9 #
10 # Note that not all possible configuration values are present in this
11 # autogenerated file.
12 #
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
15
16 from __future__ import absolute_import, division, print_function, unicode_literals
17
18 import sys
19 import os
20 import shlex
21
22 # If extensions (or modules to document with autodoc) are in another directory,
23 # add these directories to sys.path here. If the directory is relative to the
24 # documentation root, use os.path.abspath to make it absolute, like shown here.
25 #sys.path.insert(0, os.path.abspath('.'))
26
27 # -- General configuration ------------------------------------------------
28
29 # If your documentation needs a minimal Sphinx version, state it here.
30 #needs_sphinx = '1.0'
31
32 # Add any Sphinx extension module names here, as strings. They can be
33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 # ones.
35 extensions = [
36 'sphinx.ext.todo',
37 'sphinx.ext.ifconfig',
38 ]
39
40 # Add any paths that contain templates here, relative to this directory.
41 templates_path = ['_templates']
42
43 # The suffix(es) of source filenames.
44 # You can specify multiple suffix as a list of string:
45 # source_suffix = ['.rst', '.md']
46 source_suffix = '.rst'
47
48 # The encoding of source files.
49 #source_encoding = 'utf-8-sig'
50
51 # The master toctree document.
52 master_doc = 'contents'
53
54 # General information about the project.
55 project = 'Flent: The FLExible Network Tester'
56 copyright = '2012-2024, Toke Høiland-Jørgensen and contributors. Source code is GPLv3. Documentation is CC-BY-SA. Neither license affects any output produced by Flent'
57 author = 'Toke Høiland-Jørgensen'
58
59 # The version info for the project you're documenting, acts as replacement for
60 # |version| and |release|, also used in various other places throughout the
61 # built documents.
62 version = '2.3.0'
63 #
64 # The short X.Y version.
65 # The full version, including alpha/beta/rc tags.
66 release = version
67
68 # The language for content autogenerated by Sphinx. Refer to documentation
69 # for a list of supported languages.
70 #
71 # This is also used if you do content translation via gettext catalogs.
72 # Usually you set "language" from the command line for these cases.
73 language = 'en'
74
75 # There are two options for replacing |today|: either, you set today to some
76 # non-false value, then it is used:
77 #today = ''
78 # Else, today_fmt is used as the format for a strftime call.
79 today_fmt = '%B %d, %Y'
80
81 # List of patterns, relative to source directory, that match files and
82 # directories to ignore when looking for source files.
83 exclude_patterns = ['_build']
84
85 # The reST default role (used for this markup: `text`) to use for all
86 # documents.
87 #default_role = None
88
89 # If true, '()' will be appended to :func: etc. cross-reference text.
90 #add_function_parentheses = True
91
92 # If true, the current module name will be prepended to all description
93 # unit titles (such as .. function::).
94 #add_module_names = True
95
96 # If true, sectionauthor and moduleauthor directives will be shown in the
97 # output. They are ignored by default.
98 #show_authors = False
99
100 # The name of the Pygments (syntax highlighting) style to use.
101 pygments_style = 'sphinx'
102
103 # A list of ignored prefixes for module index sorting.
104 #modindex_common_prefix = []
105
106 # If true, keep warnings as "system message" paragraphs in the built documents.
107 #keep_warnings = False
108
109 # If true, `todo` and `todoList` produce output, else they produce nothing.
110 todo_include_todos = True
111
112
113 # -- Options for HTML output ----------------------------------------------
114
115 # The theme to use for HTML and HTML Help pages. See the documentation for
116 # a list of builtin themes.
117 html_theme = 'haiku'
118
119 # Theme options are theme-specific and customize the look and feel of a theme
120 # further. For a list of options available for each theme, see the
121 # documentation.
122 #html_theme_options = {'rightsidebar': True}
123
124 # Add any paths that contain custom themes here, relative to this directory.
125 #html_theme_path = []
126
127 # The name for this set of Sphinx documents. If None, it defaults to
128 # "<project> v<release> documentation".
129 html_title = "Flent: The FLExible Network Tester"
130
131 # A shorter title for the navigation bar. Default is the same as html_title.
132 #html_short_title = "Flent"
133
134 # The name of an image file (relative to this directory) to place at the top
135 # of the sidebar.
136 #html_logo = None
137
138 # The name of an image file (within the static path) to use as favicon of the
139 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
140 # pixels large.
141 #html_favicon = None
142
143 # Add any paths that contain custom static files (such as style sheets) here,
144 # relative to this directory. They are copied after the builtin static files,
145 # so a file named "default.css" will overwrite the builtin "default.css".
146 html_static_path = ['_static']
147
148 # Add any extra paths that contain custom files (such as robots.txt or
149 # .htaccess) here, relative to this directory. These files are copied
150 # directly to the root of the documentation.
151 #html_extra_path = []
152
153 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
154 # using the given strftime format.
155 #html_last_updated_fmt = '%b %d, %Y'
156
157 # If true, SmartyPants will be used to convert quotes and dashes to
158 # typographically correct entities.
159 #html_use_smartypants = True
160
161 # Custom sidebar templates, maps document names to template names.
162 html_sidebars = {}
163
164 # Additional templates that should be rendered to pages, maps page names to
165 # template names.
166 html_additional_pages = {'index': 'index.html'}
167
168 # If false, no module index is generated.
169 html_domain_indices = False
170
171 # If false, no index is generated.
172 #html_use_index = True
173
174 # If true, the index is split into individual pages for each letter.
175 #html_split_index = False
176
177 # If true, links to the reST sources are added to the pages.
178 #html_show_sourcelink = True
179
180 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
181 #html_show_sphinx = True
182
183 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
184 #html_show_copyright = True
185
186 # If true, an OpenSearch description file will be output, and all pages will
187 # contain a <link> tag referring to it. The value of this option must be the
188 # base URL from which the finished HTML is served.
189 html_use_opensearch = 'https://flent.org'
190
191 # This is the file name suffix for HTML files (e.g. ".xhtml").
192 #html_file_suffix = None
193
194 # Language to be used for generating the HTML full-text search index.
195 # Sphinx supports the following languages:
196 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
197 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
198 #html_search_language = 'en'
199
200 # A dictionary with options for the search language support, empty by default.
201 # Now only 'ja' uses this config value
202 #html_search_options = {'type': 'default'}
203
204 # The name of a javascript file (relative to the configuration directory) that
205 # implements a search results scorer. If empty, the default will be used.
206 #html_search_scorer = 'scorer.js'
207
208 # Output file base name for HTML help builder.
209 htmlhelp_basename = 'FlentTheFLExibleNetworkTesterdoc'
210
211 # -- Options for LaTeX output ---------------------------------------------
212
213 latex_elements = {
214 # The paper size ('letterpaper' or 'a4paper').
215 'papersize': 'a4paper',
216
217 # The font size ('10pt', '11pt' or '12pt').
218 #'pointsize': '10pt',
219
220 # Additional stuff for the LaTeX preamble.
221 #'preamble': '',
222
223 # Latex figure (float) alignment
224 #'figure_align': 'htbp',
225 }
226
227 # Grouping the document tree into LaTeX files. List of tuples
228 # (source start file, target name, title,
229 # author, documentclass [howto, manual, or own class]).
230 latex_documents = [
231 (master_doc, 'FlentTheFLExibleNetworkTester.tex', 'Flent: The FLExible Network Tester Documentation',
232 'Toke Høiland-Jørgensen', 'manual'),
233 ]
234
235 # The name of an image file (relative to this directory) to place at the top of
236 # the title page.
237 #latex_logo = None
238
239 # For "manual" documents, if this is true, then toplevel headings are parts,
240 # not chapters.
241 #latex_use_parts = False
242
243 # If true, show page references after internal links.
244 #latex_show_pagerefs = False
245
246 # If true, show URL addresses after external links.
247 #latex_show_urls = False
248
249 # Documents to append as an appendix to all manuals.
250 #latex_appendices = []
251
252 # If false, no module index is generated.
253 #latex_domain_indices = True
254
255
256 # -- Options for manual page output ---------------------------------------
257
258 # One entry per manual page. List of tuples
259 # (source start file, name, description, authors, manual section).
260 man_pages = [
261 ('manpage', 'flent', 'Flent: The FLExible Network Tester',
262 [author], 1)
263 ]
264
265 # If true, show URL addresses after external links.
266 #man_show_urls = False
267
268
269 # -- Options for Texinfo output -------------------------------------------
270
271 # Grouping the document tree into Texinfo files. List of tuples
272 # (source start file, target name, title, author,
273 # dir menu entry, description, category)
274 texinfo_documents = [
275 (master_doc, 'FlentTheFLExibleNetworkTester', 'Flent: The FLExible Network Tester Documentation',
276 author, 'FlentTheFLExibleNetworkTester', 'One line description of project.',
277 'Miscellaneous'),
278 ]
279
280 # Documents to append as an appendix to all manuals.
281 #texinfo_appendices = []
282
283 # If false, no module index is generated.
284 #texinfo_domain_indices = True
285
286 # How to display URL addresses: 'footnote', 'no', or 'inline'.
287 #texinfo_show_urls = 'footnote'
288
289 # If true, do not generate a @detailmenu in the "Top" node's menu.
290 #texinfo_no_detailmenu = False