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 = "The Vector Packet Processor"
24 copyright = "2018-2022, Linux Foundation"
25 author = "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(
31 ["git", "describe", "--long"], stdout=subprocess.PIPE, text=True
35 # -- General configuration ---------------------------------------------------
37 # If your documentation needs a minimal Sphinx version, state it here.
39 # needs_sphinx = '1.0'
41 # Add any Sphinx extension module names here, as strings. They can be
42 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
46 "sphinx.ext.viewcode",
48 "sphinxcontrib.spelling",
51 spelling_word_list_filename = "spelling_wordlist.txt"
53 # do not spell check those files
54 spelling_exclude_patterns = ["aboutvpp/releasenotes/*"]
56 # Add any paths that contain templates here, relative to this directory.
57 templates_path = ["_templates"]
59 # The suffix(es) of source filenames.
60 # You can specify multiple suffix as a list of string:
62 source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
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"
99 # The name of an image file (relative to this directory) to place at the top
101 html_logo = "_static/fd-io_red_white.png"
103 # Theme options are theme-specific and customize the look and feel of a theme
104 # further. For a list of options available for each theme, see the
107 # html_theme_options = {}
109 # Add any paths that contain custom static files (such as style sheets) here,
110 # relative to this directory. They are copied after the builtin static files,
111 # so a file named "default.css" will overwrite the builtin "default.css".
112 html_static_path = ["_static"]
116 app.add_css_file("css/rules.css")
119 # Custom sidebar templates, must be a dictionary that maps document names
122 # The default sidebars (for documents that don't match any pattern) are
123 # defined by theme itself. Builtin themes are using these templates by
124 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
125 # 'searchbox.html']``.
130 # -- Options for HTMLHelp output ---------------------------------------------
132 # Output file base name for HTML help builder.
133 htmlhelp_basename = "Vector Packet Processor"
136 # -- Options for LaTeX output ------------------------------------------------
139 # The paper size ('letterpaper' or 'a4paper').
141 # 'papersize': 'letterpaper',
142 # The font size ('10pt', '11pt' or '12pt').
144 # 'pointsize': '10pt',
145 # 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]).
159 "Vector Packet Processor.tex",
160 "Vector Packet Processor Documentation",
167 # -- Options for manual page output ------------------------------------------
169 # One entry per manual page. List of tuples
170 # (source start file, name, description, authors, manual section).
174 "Vector Packet Processor",
175 "Vector Packet Processor Documentation",
182 # -- Options for Texinfo output ----------------------------------------------
184 # Grouping the document tree into Texinfo files. List of tuples
185 # (source start file, target name, title, author,
186 # dir menu entry, description, category)
187 texinfo_documents = [
190 "Vector Packet Processor",
191 "Vector Packet Processor Documentation",
193 "Vector Packet Processor",
194 "One line description of project.",
200 # -- Extension configuration -------------------------------------------------