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