1 # -*- coding: utf-8 -*-
3 # VPP test framework documentation build configuration file, created by
4 # sphinx-quickstart on Thu Oct 13 08:45:03 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.
22 from datetime import date
23 sys.path.insert(0, os.path.abspath('..'))
25 # -- General configuration ------------------------------------------------
27 # If your documentation needs a minimal Sphinx version, state it here.
29 # needs_sphinx = '1.0'
31 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
37 autodoc_mock_imports = ['objgraph',
43 'syslog_rfc5424_parser',
46 # Add any paths that contain templates here, relative to this directory.
47 templates_path = ['_templates']
49 # The suffix(es) of source filenames.
50 # You can specify multiple suffix as a list of string:
52 # source_suffix = ['.rst', '.md']
53 source_suffix = '.rst'
55 # The encoding of source files.
57 # source_encoding = 'utf-8-sig'
59 # The master toctree document.
62 # General information about the project.
63 project = u'VPP test framework'
64 copyright = f'{date.today().year}, FD.io VPP team'
65 author = u'FD.io VPP team'
67 # The version info for the project you're documenting, acts as replacement for
68 # |version| and |release|, also used in various other places throughout the
71 # The short X.Y version.
72 output = subprocess.run(['../../src/scripts/version'], stdout=subprocess.PIPE)
73 version = f'{output.stdout.decode("utf-8")}'
74 # The full version, including alpha/beta/rc tags.
75 release = f'{output.stdout.decode("utf-8")}'
77 # The language for content autogenerated by Sphinx. Refer to documentation
78 # for a list of supported languages.
80 # This is also used if you do content translation via gettext catalogs.
81 # Usually you set "language" from the command line for these cases.
84 # There are two options for replacing |today|: either, you set today to some
85 # non-false value, then it is used:
89 # Else, today_fmt is used as the format for a strftime call.
91 # today_fmt = '%B %d, %Y'
93 # List of patterns, relative to source directory, that match files and
94 # directories to ignore when looking for source files.
95 # This patterns also effect to html_static_path and html_extra_path
96 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
98 # The reST default role (used for this markup: `text`) to use for all
103 # If true, '()' will be appended to :func: etc. cross-reference text.
105 add_function_parentheses = True
107 # If true, the current module name will be prepended to all description
108 # unit titles (such as .. function::).
110 # add_module_names = True
112 # If true, sectionauthor and moduleauthor directives will be shown in the
113 # output. They are ignored by default.
115 # show_authors = False
117 # The name of the Pygments (syntax highlighting) style to use.
118 pygments_style = 'sphinx'
120 # A list of ignored prefixes for module index sorting.
121 # modindex_common_prefix = []
123 # If true, keep warnings as "system message" paragraphs in the built documents.
124 # keep_warnings = False
126 # If true, `todo` and `todoList` produce output, else they produce nothing.
127 todo_include_todos = False
130 # -- Options for HTML output ----------------------------------------------
132 # The theme to use for HTML and HTML Help pages. See the documentation for
133 # a list of builtin themes.
135 # html_theme = 'alabaster'
136 html_theme = 'sphinx_rtd_theme'
138 # Theme options are theme-specific and customize the look and feel of a theme
139 # further. For a list of options available for each theme, see the
142 # html_theme_options = {}
144 # Add any paths that contain custom themes here, relative to this directory.
145 # html_theme_path = []
147 # The name for this set of Sphinx documents.
148 # "<project> v<release> documentation" by default.
150 # html_title = u'VPP test framework v0.1'
152 # A shorter title for the navigation bar. Default is the same as html_title.
154 # html_short_title = None
156 # The name of an image file (relative to this directory) to place at the top
161 # The name of an image file (relative to this directory) to use as a favicon of
162 # the docs. This file should be a Windows icon file (.ico) being 16x16 or
163 # 32x32 pixels large.
165 # html_favicon = None
167 # Add any paths that contain custom static files (such as style sheets) here,
168 # relative to this directory. They are copied after the builtin static files,
169 # so a file named "default.css" will overwrite the builtin "default.css".
170 # html_static_path = []
172 # Add any extra paths that contain custom files (such as robots.txt or
173 # .htaccess) here, relative to this directory. These files are copied
174 # directly to the root of the documentation.
176 # html_extra_path = []
178 # If not None, a 'Last updated on:' timestamp is inserted at every page
179 # bottom, using the given strftime format.
180 # The empty string is equivalent to '%b %d, %Y'.
182 # html_last_updated_fmt = None
184 # If true, SmartyPants will be used to convert quotes and dashes to
185 # typographically correct entities.
187 # html_use_smartypants = True
189 # Custom sidebar templates, maps document names to template names.
193 # Additional templates that should be rendered to pages, maps page names to
196 # html_additional_pages = {}
198 # If false, no module index is generated.
200 # html_domain_indices = True
202 # If false, no index is generated.
204 # html_use_index = True
206 # If true, the index is split into individual pages for each letter.
208 # html_split_index = False
210 # If true, links to the reST sources are added to the pages.
212 # html_show_sourcelink = True
214 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
216 # html_show_sphinx = True
218 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
220 # html_show_copyright = True
222 # If true, an OpenSearch description file will be output, and all pages will
223 # contain a <link> tag referring to it. The value of this option must be the
224 # base URL from which the finished HTML is served.
226 # html_use_opensearch = ''
228 # This is the file name suffix for HTML files (e.g. ".xhtml").
229 # html_file_suffix = None
231 # Language to be used for generating the HTML full-text search index.
232 # Sphinx supports the following languages:
233 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
234 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
236 # html_search_language = 'en'
238 # A dictionary with options for the search language support, empty by default.
239 # 'ja' uses this config value.
240 # 'zh' user can custom change `jieba` dictionary path.
242 # html_search_options = {'type': 'default'}
244 # The name of a javascript file (relative to the configuration directory) that
245 # implements a search results scorer. If empty, the default will be used.
247 # html_search_scorer = 'scorer.js'
249 # Output file base name for HTML help builder.
250 htmlhelp_basename = 'VPPtestframeworkdoc'
252 # -- Options for LaTeX output ---------------------------------------------
255 # The paper size ('letterpaper' or 'a4paper').
257 # 'papersize': 'letterpaper',
259 # The font size ('10pt', '11pt' or '12pt').
261 # 'pointsize': '10pt',
263 # Additional stuff for the LaTeX preamble.
267 # Latex figure (float) alignment
269 # 'figure_align': 'htbp',
272 # Grouping the document tree into LaTeX files. List of tuples
273 # (source start file, target name, title,
274 # author, documentclass [howto, manual, or own class]).
276 (master_doc, 'VPPtestframework.tex', u'VPP test framework Documentation',
277 u'VPP team', 'manual'),
280 # The name of an image file (relative to this directory) to place at the top of
285 # For "manual" documents, if this is true, then toplevel headings are parts,
288 # latex_use_parts = False
290 # If true, show page references after internal links.
292 # latex_show_pagerefs = False
294 # If true, show URL addresses after external links.
296 # latex_show_urls = False
298 # Documents to append as an appendix to all manuals.
300 # latex_appendices = []
302 # It false, will not define \strong, \code, itleref, \crossref ... but only
303 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
306 # latex_keep_old_macro_names = True
308 # If false, no module index is generated.
310 # latex_domain_indices = True
313 # -- Options for manual page output ---------------------------------------
315 # One entry per manual page. List of tuples
316 # (source start file, name, description, authors, manual section).
318 (master_doc, 'vpptestframework', u'VPP test framework Documentation',
322 # If true, show URL addresses after external links.
324 # man_show_urls = False
327 # -- Options for Texinfo output -------------------------------------------
329 # Grouping the document tree into Texinfo files. List of tuples
330 # (source start file, target name, title, author,
331 # dir menu entry, description, category)
332 texinfo_documents = [
333 (master_doc, 'VPPtestframework', u'VPP test framework Documentation',
334 author, 'VPPtestframework', 'One line description of project.',
338 # Documents to append as an appendix to all manuals.
340 # texinfo_appendices = []
342 # If false, no module index is generated.
344 # texinfo_domain_indices = True
346 # How to display URL addresses: 'footnote', 'no', or 'inline'.
348 # texinfo_show_urls = 'footnote'
350 # If true, do not generate a @detailmenu in the "Top" node's menu.
352 # texinfo_no_detailmenu = False