docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Configuration file for the Sphinx documentation builder.
   4 #
   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
   8
   9 # -- Path setup --------------------------------------------------------------
  10
  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.
  14 #
  15 # import os
  16 # import sys
  17 # sys.path.insert(0, os.path.abspath('.'))
  18
  19 import subprocess
  20
  21 # -- Project information -----------------------------------------------------
  22
  23 project = u'The Vector Packet Processor'
  24 copyright = u'2018-2021, Linux Foundation'
  25 author = u'FD.io VPP Community'
  26
  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
  31
  32
  33 # -- General configuration ---------------------------------------------------
  34
  35 # If your documentation needs a minimal Sphinx version, state it here.
  36 #
  37 # needs_sphinx = '1.0'
  38
  39 # Add any Sphinx extension module names here, as strings. They can be
  40 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  41 # ones.
  42 extensions = [
  43     'sphinx.ext.autodoc',
  44     'sphinx.ext.viewcode',
  45     'recommonmark',
  46     'sphinxcontrib.spelling']
  47
  48 spelling_word_list_filename = 'spelling_wordlist.txt'
  49
  50 # do not spell check those files
  51 spelling_exclude_patterns = ['aboutvpp/releasenotes/*']
  52
  53 # Add any paths that contain templates here, relative to this directory.
  54 templates_path = ['_templates']
  55
  56 # The suffix(es) of source filenames.
  57 # You can specify multiple suffix as a list of string:
  58 #
  59 source_suffix = {
  60     '.rst': 'restructuredtext',
  61     '.md': 'markdown'
  62 }
  63
  64 # The master toctree document.
  65 master_doc = 'index'
  66
  67 # The language for content autogenerated by Sphinx. Refer to documentation
  68 # for a list of supported languages.
  69 #
  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.
  72 language = None
  73
  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']
  78
  79 # The name of the Pygments (syntax highlighting) style to use.
  80 pygments_style = 'default'
  81
  82
  83 # -- Options for HTML output -------------------------------------------------
  84
  85 # The theme to use for HTML and HTML Help pages.  See the documentation for
  86 # a list of builtin themes.
  87 #
  88
  89 # import sphinx_theme
  90
  91 html_theme = "sphinx_rtd_theme"
  92 # html_theme = 'neo_rtd_theme'
  93
  94 html_theme_path = ["_themes", ]
  95 # html_theme_path = [sphinx_theme.get_html_theme_path('neo-rtd-theme')]
  96
  97 # All available themes:
  98 # print(sphinx_theme.THEME_LIST)
  99 # >> ['stanford_theme', 'neo_rtd_theme']
 100
 101 # The name of an image file (relative to this directory) to place at the top
 102 # of the sidebar.
 103 html_logo = '_static/fd-io_red_white.png'
 104
 105 # Theme options are theme-specific and customize the look and feel of a theme
 106 # further.  For a list of options available for each theme, see the
 107 # documentation.
 108 #
 109 # html_theme_options = {}
 110
 111 # Add any paths that contain custom static files (such as style sheets) here,
 112 # relative to this directory. They are copied after the builtin static files,
 113 # so a file named "default.css" will overwrite the builtin "default.css".
 114 html_static_path = ['_static']
 115
 116
 117 def setup(app):
 118     app.add_css_file('css/rules.css')
 119
 120 # Custom sidebar templates, must be a dictionary that maps document names
 121 # to template names.
 122 #
 123 # The default sidebars (for documents that don't match any pattern) are
 124 # defined by theme itself.  Builtin themes are using these templates by
 125 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 126 # 'searchbox.html']``.
 127 #
 128 # html_sidebars = {}
 129
 130
 131 # -- Options for HTMLHelp output ---------------------------------------------
 132
 133 # Output file base name for HTML help builder.
 134 htmlhelp_basename = 'Vector Packet Processor'
 135
 136
 137 # -- Options for LaTeX output ------------------------------------------------
 138
 139 latex_elements = {
 140     # The paper size ('letterpaper' or 'a4paper').
 141     #
 142     # 'papersize': 'letterpaper',
 143
 144     # The font size ('10pt', '11pt' or '12pt').
 145     #
 146     # 'pointsize': '10pt',
 147
 148     # Additional stuff for the LaTeX preamble.
 149     #
 150     # 'preamble': '',
 151
 152     # Latex figure (float) alignment
 153     #
 154     # 'figure_align': 'htbp',
 155 }
 156
 157 # Grouping the document tree into LaTeX files. List of tuples
 158 # (source start file, target name, title,
 159 #  author, documentclass [howto, manual, or own class]).
 160 latex_documents = [
 161     (master_doc, 'Vector Packet Processor.tex',
 162      u'Vector Packet Processor Documentation',
 163      u'John DeNisco', 'manual'),
 164 ]
 165
 166
 167 # -- Options for manual page output ------------------------------------------
 168
 169 # One entry per manual page. List of tuples
 170 # (source start file, name, description, authors, manual section).
 171 man_pages = [
 172     (master_doc, 'Vector Packet Processor',
 173      u'Vector Packet Processor Documentation',
 174      [author], 1)
 175 ]
 176
 177
 178 # -- Options for Texinfo output ----------------------------------------------
 179
 180 # Grouping the document tree into Texinfo files. List of tuples
 181 # (source start file, target name, title, author,
 182 #  dir menu entry, description, category)
 183 texinfo_documents = [
 184     (master_doc, 'Vector Packet Processor',
 185      u'Vector Packet Processor Documentation',
 186      author, 'Vector Packet Processor', 'One line description of project.',
 187      'Miscellaneous'),
 188 ]
 189
 190
 191 # -- Extension configuration -------------------------------------------------