Code Review
/
vpp.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
svm: support multi-chunk fifo chunk alloc
[vpp.git]
/
docs
/
conf.py
diff --git
a/docs/conf.py
b/docs/conf.py
index
aef3646
..
6d8ed9f
100644
(file)
--- a/
docs/conf.py
+++ b/
docs/conf.py
@@
-18,14
+18,14
@@
# -- Project information -----------------------------------------------------
# -- Project information -----------------------------------------------------
-project = u'Vector Packet Processor'
+project = u'
The
Vector Packet Processor'
copyright = u'2018, Linux Foundation'
author = u'John DeNisco'
# The short X.Y version
copyright = u'2018, Linux Foundation'
author = u'John DeNisco'
# The short X.Y version
-version = u'
19.08
'
+version = u'
master
'
# The full version, including alpha/beta/rc tags
# The full version, including alpha/beta/rc tags
-release = u'01'
+release = u'
20.
01'
# -- General configuration ---------------------------------------------------
# -- General configuration ---------------------------------------------------
@@
-40,9
+40,12
@@
release = u'01'
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
- 'recommonmark',
-]
+ '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']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@
-52,7
+55,7
@@
templates_path = ['_templates']
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown'
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown'
-
}
+}
# The master toctree document.
master_doc = 'index'
# The master toctree document.
master_doc = 'index'
@@
-106,6
+109,7
@@
html_logo = '_static/fd-io_red_white.png'
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# 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')
def setup(app):
app.add_stylesheet('css/rules.css')
@@
-150,7
+154,8
@@
latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
# (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'),
]
u'John DeNisco', 'manual'),
]
@@
-160,7
+165,8
@@
latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
# 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)
]
[author], 1)
]
@@
-171,7
+177,8
@@
man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
# (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'),
]
author, 'Vector Packet Processor', 'One line description of project.',
'Miscellaneous'),
]