# import sys
# sys.path.insert(0, os.path.abspath('.'))
+import subprocess
+
# -- Project information -----------------------------------------------------
project = u'The Vector Packet Processor'
-copyright = u'2018-2020, Linux Foundation'
-author = u'John DeNisco'
+copyright = u'2018-2021, Linux Foundation'
+author = u'FD.io VPP Community'
# The short X.Y version
-version = u'master'
+version = subprocess.run(["git", "describe"], stdout=subprocess.PIPE, text=True).stdout
# The full version, including alpha/beta/rc tags
-release = u'20.01'
+release = subprocess.run(["git", "describe", "--long"], stdout=subprocess.PIPE, text=True).stdout
# -- General configuration ---------------------------------------------------
'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']
# 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'
# import sphinx_theme
+templates_path = ['_templates']
+
html_theme = "sphinx_rtd_theme"
-# html_theme = 'neo_rtd_theme'
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.
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.