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