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