# -- Project information -----------------------------------------------------
-project = u'Vector Packet Processor'
-copyright = u'2018, John DeNisco'
+project = u'The Vector Packet Processor'
+copyright = u'2018, Linux Foundation'
author = u'John DeNisco'
# The short X.Y version
-version = u''
+version = u'master'
# The full version, including alpha/beta/rc tags
-release = u'0.1'
+release = u'20.01'
# -- General configuration ---------------------------------------------------
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
-]
+ 'recommonmark']
+
+# This is currently breaking the build
+#### 'sphinxcontrib.spelling']
+spelling_word_list_filename = 'spelling_wordlist.txt'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
-source_suffix = ['.rst', '.md']
-source_parsers = {
- '.md': 'recommonmark.parser.CommonMarkParser',
+source_suffix = {
+ '.rst': 'restructuredtext',
+ '.md': 'markdown'
}
+
# The master toctree document.
master_doc = 'index'
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
+
def setup(app):
app.add_stylesheet('css/rules.css')
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- (master_doc, 'Vector Packet Processor.tex', u'Vector Packet Processor Documentation',
+ (master_doc, 'Vector Packet Processor.tex',
+ u'Vector Packet Processor Documentation',
u'John DeNisco', 'manual'),
]
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- (master_doc, 'Vector Packet Processor', u'Vector Packet Processor Documentation',
+ (master_doc, 'Vector Packet Processor',
+ u'Vector Packet Processor Documentation',
[author], 1)
]
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- (master_doc, 'Vector Packet Processor', u'Vector Packet Processor Documentation',
+ (master_doc, 'Vector Packet Processor',
+ u'Vector Packet Processor Documentation',
author, 'Vector Packet Processor', 'One line description of project.',
'Miscellaneous'),
]