1 # Copyright 2017 Cisco Systems, Inc. All rights reserved.
3 # Licensed under the Apache License, Version 2.0 (the "License"); you may
4 # not use this file except in compliance with the License. You may obtain
5 # a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 # License for the specific language governing permissions and limitations
15 # NFVBench documentation build configuration file, created by
16 # sphinx-quickstart on Thu Sep 29 14:25:18 2016.
18 # This file is execfile()d with the current directory set to its
21 # Note that not all possible configuration values are present in this
24 # All configuration values have a default; values that are commented out
25 # serve to show the default.
27 # If extensions (or modules to document with autodoc) are in another directory,
28 # add these directories to sys.path here. If the directory is relative to the
29 # documentation root, use os.path.abspath to make it absolute, like shown here.
36 # sys.path.insert(0, os.path.abspath('.'))
38 from pbr import version as pbr_ver
41 sys.path.insert(0, os.path.abspath('../..'))
43 # -- General configuration ------------------------------------------------
45 # If your documentation needs a minimal Sphinx version, state it here.
47 # needs_sphinx = '1.0'
49 # Add any Sphinx extension module names here, as strings. They can be
50 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
54 # Add any paths that contain templates here, relative to this directory.
55 templates_path = ['_templates']
57 # The suffix(es) of source filenames.
58 # You can specify multiple suffix as a list of string:
60 # source_suffix = ['.rst', '.md']
61 source_suffix = '.rst'
63 # The encoding of source files.
65 # source_encoding = 'utf-8-sig'
67 # The master toctree document.
70 # General information about the project.
72 copyright = u'2016 Cisco Systems, Inc.'
73 author = u'Cisco Systems, Inc.'
75 # The version info for the project you're documenting, acts as replacement for
76 # |version| and |release|, also used in various other places throughout the
79 # The short X.Y version.
80 version = pbr_ver.VersionInfo(project).version_string()
81 # The full version, including alpha/beta/rc tags.
82 release = pbr_ver.VersionInfo(project).version_string_with_vcs()
84 # The language for content autogenerated by Sphinx. Refer to documentation
85 # for a list of supported languages.
87 # This is also used if you do content translation via gettext catalogs.
88 # Usually you set "language" from the command line for these cases.
91 # There are two options for replacing |today|: either, you set today to some
92 # non-false value, then it is used:
96 # Else, today_fmt is used as the format for a strftime call.
98 # today_fmt = '%B %d, %Y'
100 # List of patterns, relative to source directory, that match files and
101 # directories to ignore when looking for source files.
102 # This patterns also effect to html_static_path and html_extra_path
103 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
105 # The reST default role (used for this markup: `text`) to use for all
108 # default_role = None
110 # If true, '()' will be appended to :func: etc. cross-reference text.
112 # add_function_parentheses = True
114 # If true, the current module name will be prepended to all description
115 # unit titles (such as .. function::).
117 # add_module_names = True
119 # If true, sectionauthor and moduleauthor directives will be shown in the
120 # output. They are ignored by default.
122 # show_authors = False
124 # The name of the Pygments (syntax highlighting) style to use.
125 pygments_style = 'sphinx'
127 # A list of ignored prefixes for module index sorting.
128 # modindex_common_prefix = []
130 # If true, keep warnings as "system message" paragraphs in the built documents.
131 # keep_warnings = False
133 # If true, `todo` and `todoList` produce output, else they produce nothing.
134 todo_include_todos = False
136 # -- Options for HTML output ----------------------------------------------
138 # The theme to use for HTML and HTML Help pages. See the documentation for
139 # a list of builtin themes.
141 # html_theme = 'haiku'
142 html_theme = 'sphinx_rtd_theme'
144 # Theme options are theme-specific and customize the look and feel of a theme
145 # further. For a list of options available for each theme, see the
148 html_theme_options = {}
150 # Add any paths that contain custom themes here, relative to this directory.
151 # html_theme_path = []
153 # The name for this set of Sphinx documents.
154 # "<project> v<release> documentation" by default.
156 # html_title = u'NFVBench vdev117'
158 # A shorter title for the navigation bar. Default is the same as html_title.
160 html_short_title = 'nfvbench'
162 # The name of an image file (relative to this directory) to place at the topß
167 # The name of an image file (relative to this directory) to use as a favicon of
168 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
171 # html_favicon = None
173 # Add any paths that contain custom static files (such as style sheets) here,
174 # relative to this directory. They are copied after the builtin static files,
175 # so a file named "default.css" will overwrite the builtin "default.css".
176 html_static_path = ['_static']
178 # Add any extra paths that contain custom files (such as robots.txt or
179 # .htaccess) here, relative to this directory. These files are copied
180 # directly to the root of the documentation.
182 # html_extra_path = []
184 # If not None, a 'Last updated on:' timestamp is inserted at every page
185 # bottom, using the given strftime format.
186 # The empty string is equivalent to '%b %d, %Y'.
188 # html_last_updated_fmt = None
190 # If true, SmartyPants will be used to convert quotes and dashes to
191 # typographically correct entities.
193 html_use_smartypants = False
195 # Custom sidebar templates, maps document names to template names.
199 # Additional templates that should be rendered to pages, maps page names to
202 # html_additional_pages = {}
204 # If false, no module index is generated.
206 # html_domain_indices = True
208 # If false, no index is generated.
210 # html_use_index = True
212 # If true, the index is split into individual pages for each letter.
214 # html_split_index = False
216 # If true, links to the reST sources are added to the pages.
218 # html_show_sourcelink = True
220 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
222 # html_show_sphinx = True
224 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
226 # html_show_copyright = True
228 # If true, an OpenSearch description file will be output, and all pages will
229 # contain a <link> tag referring to it. The value of this option must be the
230 # base URL from which the finished HTML is served.
232 # html_use_opensearch = ''
234 # This is the file name suffix for HTML files (e.g. ".xhtml").
235 # html_file_suffix = None
237 # Language to be used for generating the HTML full-text search index.
238 # Sphinx supports the following languages:
239 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
240 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
242 # html_search_language = 'en'
244 # A dictionary with options for the search language support, empty by default.
245 # 'ja' uses this config value.
246 # 'zh' user can custom change `jieba` dictionary path.
248 # html_search_options = {'type': 'default'}
250 # The name of a javascript file (relative to the configuration directory) that
251 # implements a search results scorer. If empty, the default will be used.
253 # html_search_scorer = 'scorer.js'
255 # Output file base name for HTML help builder.
256 htmlhelp_basename = 'NFVBenchdoc'
258 # -- Options for LaTeX output ---------------------------------------------
261 # The paper size ('letterpaper' or 'a4paper').
263 # 'papersize': 'letterpaper',
265 # The font size ('10pt', '11pt' or '12pt').
267 # 'pointsize': '10pt',
269 # Additional stuff for the LaTeX preamble.
273 # Latex figure (float) alignment
275 # 'figure_align': 'htbp',
278 # Grouping the document tree into LaTeX files. List of tuples
279 # (source start file, target name, title,
280 # author, documentclass [howto, manual, or own class]).
282 (master_doc, 'NFVBench.tex', u'NFVBench Documentation',
283 u'Alec Hothan, Stefano Suryanto, Jan Balaz', 'manual'),
286 # The name of an image file (relative to this directory) to place at the top of
291 # For "manual" documents, if this is true, then toplevel headings are parts,
294 # latex_use_parts = False
296 # If true, show page references after internal links.
298 # latex_show_pagerefs = False
300 # If true, show URL addresses after external links.
302 # latex_show_urls = False
304 # Documents to append as an appendix to all manuals.
306 # latex_appendices = []
308 # It false, will not define \strong, \code, itleref, \crossref ... but only
309 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
312 # latex_keep_old_macro_names = True
314 # If false, no module index is generated.
316 # latex_domain_indices = True
319 # -- Options for manual page output ---------------------------------------
321 # One entry per manual page. List of tuples
322 # (source start file, name, description, authors, manual section).
324 (master_doc, 'nfvbench', u'NFVBench Documentation',
328 # If true, show URL addresses after external links.
330 # man_show_urls = False
333 # -- Options for Texinfo output -------------------------------------------
335 # Grouping the document tree into Texinfo files. List of tuples
336 # (source start file, target name, title, author,
337 # dir menu entry, description, category)
338 texinfo_documents = [
339 (master_doc, 'NFVBench', u'NFVBench Documentation',
340 author, 'NFVBench', 'One line description of project.',
344 # Documents to append as an appendix to all manuals.
346 # texinfo_appendices = []
348 # If false, no module index is generated.
350 # texinfo_domain_indices = True
352 # How to display URL addresses: 'footnote', 'no', or 'inline'.
354 # texinfo_show_urls = 'footnote'
356 # If true, do not generate a @detailmenu in the "Top" node's menu.
358 # texinfo_no_detailmenu = False