X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=ed4de0e7d72e1b5ce5d7a87b147b4527659c652b;hb=2164f7bf58feacdedce61c5b5790980b533ae5bf;hp=09c4d9b4ce4d0cd4d8e006abe4ed76e473610474;hpb=d170681b24724c522adaf1e2f4f0e1f3289dbf82;p=vpp.git diff --git a/docs/conf.py b/docs/conf.py index 09c4d9b4ce4..ed4de0e7d72 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,6 +16,8 @@ # import sys # sys.path.insert(0, os.path.abspath('.')) +import subprocess + # -- Project information ----------------------------------------------------- project = u'The Vector Packet Processor' @@ -23,9 +25,9 @@ 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 --------------------------------------------------- @@ -44,6 +46,10 @@ extensions = [ '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'] @@ -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 . -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' @@ -82,15 +88,11 @@ 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.