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