Code Review
/
vpp.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
libmemif: refactor examples
[vpp.git]
/
docs
/
conf.py
diff --git
a/docs/conf.py
b/docs/conf.py
index
f3332c9
..
26ccb3f
100644
(file)
--- a/
docs/conf.py
+++ b/
docs/conf.py
@@
-16,16
+16,18
@@
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# import sys
# sys.path.insert(0, os.path.abspath('.'))
+import subprocess
+
# -- Project information -----------------------------------------------------
# -- Project information -----------------------------------------------------
-project = u'Vector Packet Processor'
-copyright = u'2018, Linux Foundation'
-author = u'
John DeNisco
'
+project = u'
The
Vector Packet Processor'
+copyright = u'2018
-2022
, Linux Foundation'
+author = u'
FD.io VPP Community
'
# The short X.Y version
# The short X.Y version
-version =
u'19.08'
+version =
subprocess.run(["git", "describe"], stdout=subprocess.PIPE, text=True).stdout
# The full version, including alpha/beta/rc tags
# The full version, including alpha/beta/rc tags
-release =
u'01'
+release =
subprocess.run(["git", "describe", "--long"], stdout=subprocess.PIPE, text=True).stdout
# -- General configuration ---------------------------------------------------
# -- General configuration ---------------------------------------------------
@@
-41,8
+43,12
@@
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'recommonmark',
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'recommonmark',
- 'sphinx_markdown_tables'
-]
+ 'sphinxcontrib.spelling']
+
+spelling_word_list_filename = 'spelling_wordlist.txt'
+
+# do not spell check those files
+spelling_exclude_patterns = ['aboutvpp/releasenotes/*']
# 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']
@@
-53,7
+59,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'
@@
-68,7
+74,7
@@
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = [
u'_build', 'Thumbs.db', '.DS_Store
']
+exclude_patterns = [
'Thumbs.db', '.DS_Store', '_scripts', 'venv', '_generated
']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'default'
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'default'
@@
-82,15
+88,11
@@
pygments_style = 'default'
# import sphinx_theme
# import sphinx_theme
+templates_path = ['_templates']
+
html_theme = "sphinx_rtd_theme"
html_theme = "sphinx_rtd_theme"
-# html_theme = 'neo_rtd_theme'
html_theme_path = ["_themes", ]
html_theme_path = ["_themes", ]
-# html_theme_path = [sphinx_theme.get_html_theme_path('neo-rtd-theme')]
-
-# All available themes:
-# print(sphinx_theme.THEME_LIST)
-# >> ['stanford_theme', 'neo_rtd_theme']
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
@@
-107,8
+109,9
@@
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):
def setup(app):
- app.add_
stylesheet
('css/rules.css')
+ app.add_
css_file
('css/rules.css')
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
@@
-151,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'),
]
@@
-161,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)
]
@@
-172,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'),
]