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('.'))
19 # -- Project information -----------------------------------------------------
21 project = u'Vector Packet Processor'
22 copyright = u'2018, Linux Foundation'
23 author = u'John DeNisco'
25 # The short X.Y version
27 # The full version, including alpha/beta/rc tags
31 # -- General configuration ---------------------------------------------------
33 # If your documentation needs a minimal Sphinx version, state it here.
35 # needs_sphinx = '1.0'
37 # Add any Sphinx extension module names here, as strings. They can be
38 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
42 'sphinx.ext.viewcode',
46 # Add any paths that contain templates here, relative to this directory.
47 templates_path = ['_templates']
49 # The suffix(es) of source filenames.
50 # You can specify multiple suffix as a list of string:
53 '.rst': 'restructuredtext',
57 # The master toctree document.
60 # The language for content autogenerated by Sphinx. Refer to documentation
61 # for a list of supported languages.
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.
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']
72 # The name of the Pygments (syntax highlighting) style to use.
73 pygments_style = 'default'
76 # -- Options for HTML output -------------------------------------------------
78 # The theme to use for HTML and HTML Help pages. See the documentation for
79 # a list of builtin themes.
84 html_theme = "sphinx_rtd_theme"
85 # html_theme = 'neo_rtd_theme'
87 html_theme_path = ["_themes", ]
88 # html_theme_path = [sphinx_theme.get_html_theme_path('neo-rtd-theme')]
90 # All available themes:
91 # print(sphinx_theme.THEME_LIST)
92 # >> ['stanford_theme', 'neo_rtd_theme']
94 # The name of an image file (relative to this directory) to place at the top
96 html_logo = '_static/fd-io_red_white.png'
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
102 # html_theme_options = {}
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']
110 app.add_stylesheet('css/rules.css')
112 # Custom sidebar templates, must be a dictionary that maps document names
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']``.
123 # -- Options for HTMLHelp output ---------------------------------------------
125 # Output file base name for HTML help builder.
126 htmlhelp_basename = 'Vector Packet Processor'
129 # -- Options for LaTeX output ------------------------------------------------
132 # The paper size ('letterpaper' or 'a4paper').
134 # 'papersize': 'letterpaper',
136 # The font size ('10pt', '11pt' or '12pt').
138 # 'pointsize': '10pt',
140 # Additional stuff for the LaTeX preamble.
144 # Latex figure (float) alignment
146 # 'figure_align': 'htbp',
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]).
153 (master_doc, 'Vector Packet Processor.tex', u'Vector Packet Processor Documentation',
154 u'John DeNisco', 'manual'),
158 # -- Options for manual page output ------------------------------------------
160 # One entry per manual page. List of tuples
161 # (source start file, name, description, authors, manual section).
163 (master_doc, 'Vector Packet Processor', u'Vector Packet Processor Documentation',
168 # -- Options for Texinfo output ----------------------------------------------
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.',
180 # -- Extension configuration -------------------------------------------------