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