1 # -*- coding: utf-8 -*-
3 # Configuration file for the Sphinx documentation builder.
5 # This file does only contain a selection of the most common options. For a
6 # full list see the documentation:
7 # http://www.sphinx-doc.org/en/stable/config
9 # -- Path setup --------------------------------------------------------------
11 # If extensions (or modules to document with autodoc) are in another directory,
12 # add these directories to sys.path here. If the directory is relative to the
13 # documentation root, use os.path.abspath to make it absolute, like shown here.
17 # sys.path.insert(0, os.path.abspath('.'))
21 # -- Project information -----------------------------------------------------
23 project = u'The Vector Packet Processor'
24 copyright = u'2018-2021, Linux Foundation'
25 author = u'FD.io VPP Community'
27 # The short X.Y version
28 version = subprocess.run(["git", "describe"], stdout=subprocess.PIPE, text=True).stdout
29 # The full version, including alpha/beta/rc tags
30 release = subprocess.run(["git", "describe", "--long"], stdout=subprocess.PIPE, text=True).stdout
33 # -- General configuration ---------------------------------------------------
35 # If your documentation needs a minimal Sphinx version, state it here.
37 # needs_sphinx = '1.0'
39 # Add any Sphinx extension module names here, as strings. They can be
40 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
44 'sphinx.ext.viewcode',
46 'sphinxcontrib.spelling']
48 spelling_word_list_filename = 'spelling_wordlist.txt'
50 # do not spell check those files
51 spelling_exclude_patterns = ['aboutvpp/releasenotes/*']
53 # Add any paths that contain templates here, relative to this directory.
54 templates_path = ['_templates']
56 # The suffix(es) of source filenames.
57 # You can specify multiple suffix as a list of string:
60 '.rst': 'restructuredtext',
64 # The master toctree document.
67 # The language for content autogenerated by Sphinx. Refer to documentation
68 # for a list of supported languages.
70 # This is also used if you do content translation via gettext catalogs.
71 # Usually you set "language" from the command line for these cases.
74 # List of patterns, relative to source directory, that match files and
75 # directories to ignore when looking for source files.
76 # This pattern also affects html_static_path and html_extra_path .
77 exclude_patterns = ['Thumbs.db', '.DS_Store', '_scripts', 'venv', '_generated']
79 # The name of the Pygments (syntax highlighting) style to use.
80 pygments_style = 'default'
83 # -- Options for HTML output -------------------------------------------------
85 # The theme to use for HTML and HTML Help pages. See the documentation for
86 # a list of builtin themes.
91 templates_path = ['_templates']
93 html_theme = "sphinx_rtd_theme"
95 html_theme_path = ["_themes", ]
97 # The name of an image file (relative to this directory) to place at the top
99 html_logo = '_static/fd-io_red_white.png'
101 # Theme options are theme-specific and customize the look and feel of a theme
102 # further. For a list of options available for each theme, see the
105 # html_theme_options = {}
107 # Add any paths that contain custom static files (such as style sheets) here,
108 # relative to this directory. They are copied after the builtin static files,
109 # so a file named "default.css" will overwrite the builtin "default.css".
110 html_static_path = ['_static']
114 app.add_css_file('css/rules.css')
116 # Custom sidebar templates, must be a dictionary that maps document names
119 # The default sidebars (for documents that don't match any pattern) are
120 # defined by theme itself. Builtin themes are using these templates by
121 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
122 # 'searchbox.html']``.
127 # -- Options for HTMLHelp output ---------------------------------------------
129 # Output file base name for HTML help builder.
130 htmlhelp_basename = 'Vector Packet Processor'
133 # -- Options for LaTeX output ------------------------------------------------
136 # The paper size ('letterpaper' or 'a4paper').
138 # 'papersize': 'letterpaper',
140 # The font size ('10pt', '11pt' or '12pt').
142 # 'pointsize': '10pt',
144 # Additional stuff for the LaTeX preamble.
148 # Latex figure (float) alignment
150 # 'figure_align': 'htbp',
153 # Grouping the document tree into LaTeX files. List of tuples
154 # (source start file, target name, title,
155 # author, documentclass [howto, manual, or own class]).
157 (master_doc, 'Vector Packet Processor.tex',
158 u'Vector Packet Processor Documentation',
159 u'John DeNisco', 'manual'),
163 # -- Options for manual page output ------------------------------------------
165 # One entry per manual page. List of tuples
166 # (source start file, name, description, authors, manual section).
168 (master_doc, 'Vector Packet Processor',
169 u'Vector Packet Processor Documentation',
174 # -- Options for Texinfo output ----------------------------------------------
176 # Grouping the document tree into Texinfo files. List of tuples
177 # (source start file, target name, title, author,
178 # dir menu entry, description, category)
179 texinfo_documents = [
180 (master_doc, 'Vector Packet Processor',
181 u'Vector Packet Processor Documentation',
182 author, 'Vector Packet Processor', 'One line description of project.',
187 # -- Extension configuration -------------------------------------------------