1 # Copyright 2017 Cisco Systems, Inc. All rights reserved.
3 # NFVBench documentation build configuration file, created by
4 # sphinx-quickstart on Thu Sep 29 14:25:18 2016.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
15 # If extensions (or modules to document with autodoc) are in another directory,
16 # add these directories to sys.path here. If the directory is relative to the
17 # documentation root, use os.path.abspath to make it absolute, like shown here.
21 # sys.path.insert(0, os.path.abspath('.'))
23 from pbr import version as pbr_ver
26 sys.path.insert(0, os.path.abspath('../..'))
28 # -- General configuration ------------------------------------------------
30 # If your documentation needs a minimal Sphinx version, state it here.
32 # needs_sphinx = '1.0'
34 # Add any Sphinx extension module names here, as strings. They can be
35 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39 # Add any paths that contain templates here, relative to this directory.
40 templates_path = ['_templates']
42 # The suffix(es) of source filenames.
43 # You can specify multiple suffix as a list of string:
45 # source_suffix = ['.rst', '.md']
46 source_suffix = '.rst'
48 # The encoding of source files.
50 # source_encoding = 'utf-8-sig'
52 # The master toctree document.
55 # General information about the project.
57 copyright = u'2016 Cisco Systems, Inc.'
58 author = u'Cisco Systems, Inc.'
60 # The version info for the project you're documenting, acts as replacement for
61 # |version| and |release|, also used in various other places throughout the
64 # The short X.Y version.
65 version = pbr_ver.VersionInfo(project).version_string()
66 # The full version, including alpha/beta/rc tags.
67 release = pbr_ver.VersionInfo(project).version_string_with_vcs()
69 # The language for content autogenerated by Sphinx. Refer to documentation
70 # for a list of supported languages.
72 # This is also used if you do content translation via gettext catalogs.
73 # Usually you set "language" from the command line for these cases.
76 # There are two options for replacing |today|: either, you set today to some
77 # non-false value, then it is used:
81 # Else, today_fmt is used as the format for a strftime call.
83 # today_fmt = '%B %d, %Y'
85 # List of patterns, relative to source directory, that match files and
86 # directories to ignore when looking for source files.
87 # This patterns also effect to html_static_path and html_extra_path
88 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
90 # The reST default role (used for this markup: `text`) to use for all
95 # If true, '()' will be appended to :func: etc. cross-reference text.
97 # add_function_parentheses = True
99 # If true, the current module name will be prepended to all description
100 # unit titles (such as .. function::).
102 # add_module_names = True
104 # If true, sectionauthor and moduleauthor directives will be shown in the
105 # output. They are ignored by default.
107 # show_authors = False
109 # The name of the Pygments (syntax highlighting) style to use.
110 pygments_style = 'sphinx'
112 # A list of ignored prefixes for module index sorting.
113 # modindex_common_prefix = []
115 # If true, keep warnings as "system message" paragraphs in the built documents.
116 # keep_warnings = False
118 # If true, `todo` and `todoList` produce output, else they produce nothing.
119 todo_include_todos = False
121 # -- Options for HTML output ----------------------------------------------
123 # The theme to use for HTML and HTML Help pages. See the documentation for
124 # a list of builtin themes.
126 # html_theme = 'haiku'
127 html_theme = 'sphinx_rtd_theme'
129 # Theme options are theme-specific and customize the look and feel of a theme
130 # further. For a list of options available for each theme, see the
133 html_theme_options = {}
135 # Add any paths that contain custom themes here, relative to this directory.
136 # html_theme_path = []
138 # The name for this set of Sphinx documents.
139 # "<project> v<release> documentation" by default.
141 # html_title = u'NFVBench vdev117'
143 # A shorter title for the navigation bar. Default is the same as html_title.
145 html_short_title = 'nfvbench'
147 # The name of an image file (relative to this directory) to place at the topß
152 # The name of an image file (relative to this directory) to use as a favicon of
153 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
156 # html_favicon = None
158 # Add any paths that contain custom static files (such as style sheets) here,
159 # relative to this directory. They are copied after the builtin static files,
160 # so a file named "default.css" will overwrite the builtin "default.css".
161 html_static_path = ['_static']
163 # Add any extra paths that contain custom files (such as robots.txt or
164 # .htaccess) here, relative to this directory. These files are copied
165 # directly to the root of the documentation.
167 # html_extra_path = []
169 # If not None, a 'Last updated on:' timestamp is inserted at every page
170 # bottom, using the given strftime format.
171 # The empty string is equivalent to '%b %d, %Y'.
173 # html_last_updated_fmt = None
175 # If true, SmartyPants will be used to convert quotes and dashes to
176 # typographically correct entities.
178 html_use_smartypants = False
180 # Custom sidebar templates, maps document names to template names.
184 # Additional templates that should be rendered to pages, maps page names to
187 # html_additional_pages = {}
189 # If false, no module index is generated.
191 # html_domain_indices = True
193 # If false, no index is generated.
195 # html_use_index = True
197 # If true, the index is split into individual pages for each letter.
199 # html_split_index = False
201 # If true, links to the reST sources are added to the pages.
203 # html_show_sourcelink = True
205 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
207 # html_show_sphinx = True
209 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
211 # html_show_copyright = True
213 # If true, an OpenSearch description file will be output, and all pages will
214 # contain a <link> tag referring to it. The value of this option must be the
215 # base URL from which the finished HTML is served.
217 # html_use_opensearch = ''
219 # This is the file name suffix for HTML files (e.g. ".xhtml").
220 # html_file_suffix = None
222 # Language to be used for generating the HTML full-text search index.
223 # Sphinx supports the following languages:
224 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
225 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
227 # html_search_language = 'en'
229 # A dictionary with options for the search language support, empty by default.
230 # 'ja' uses this config value.
231 # 'zh' user can custom change `jieba` dictionary path.
233 # html_search_options = {'type': 'default'}
235 # The name of a javascript file (relative to the configuration directory) that
236 # implements a search results scorer. If empty, the default will be used.
238 # html_search_scorer = 'scorer.js'
240 # Output file base name for HTML help builder.
241 htmlhelp_basename = 'NFVBenchdoc'
243 # -- Options for LaTeX output ---------------------------------------------
246 # The paper size ('letterpaper' or 'a4paper').
248 # 'papersize': 'letterpaper',
250 # The font size ('10pt', '11pt' or '12pt').
252 # 'pointsize': '10pt',
254 # Additional stuff for the LaTeX preamble.
258 # Latex figure (float) alignment
260 # 'figure_align': 'htbp',
263 # Grouping the document tree into LaTeX files. List of tuples
264 # (source start file, target name, title,
265 # author, documentclass [howto, manual, or own class]).
267 (master_doc, 'NFVBench.tex', u'NFVBench Documentation',
268 u'Alec Hothan, Stefano Suryanto, Jan Balaz', 'manual'),
271 # The name of an image file (relative to this directory) to place at the top of
276 # For "manual" documents, if this is true, then toplevel headings are parts,
279 # latex_use_parts = False
281 # If true, show page references after internal links.
283 # latex_show_pagerefs = False
285 # If true, show URL addresses after external links.
287 # latex_show_urls = False
289 # Documents to append as an appendix to all manuals.
291 # latex_appendices = []
293 # It false, will not define \strong, \code, itleref, \crossref ... but only
294 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
297 # latex_keep_old_macro_names = True
299 # If false, no module index is generated.
301 # latex_domain_indices = True
304 # -- Options for manual page output ---------------------------------------
306 # One entry per manual page. List of tuples
307 # (source start file, name, description, authors, manual section).
309 (master_doc, 'nfvbench', u'NFVBench Documentation',
313 # If true, show URL addresses after external links.
315 # man_show_urls = False
318 # -- Options for Texinfo output -------------------------------------------
320 # Grouping the document tree into Texinfo files. List of tuples
321 # (source start file, target name, title, author,
322 # dir menu entry, description, category)
323 texinfo_documents = [
324 (master_doc, 'NFVBench', u'NFVBench Documentation',
325 author, 'NFVBench', 'One line description of project.',
329 # Documents to append as an appendix to all manuals.
331 # texinfo_appendices = []
333 # If false, no module index is generated.
335 # texinfo_domain_indices = True
337 # How to display URL addresses: 'footnote', 'no', or 'inline'.
339 # texinfo_show_urls = 'footnote'
341 # If true, do not generate a @detailmenu in the "Top" node's menu.
343 # texinfo_no_detailmenu = False