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