X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=ed4de0e7d72e1b5ce5d7a87b147b4527659c652b;hb=2164f7bf58feacdedce61c5b5790980b533ae5bf;hp=17b4b786c3f5727a8e06ea254c0adb956dfac394;hpb=06dcd45ff81e06bc8cf40ed487c0b2652d346a5a;p=vpp.git

diff --git a/docs/conf.py b/docs/conf.py
index 17b4b786c3f..ed4de0e7d72 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -16,16 +16,18 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+import subprocess
+
 # -- Project information -----------------------------------------------------
 
-project = u'Vector Packet Processor'
-copyright = u'2018, John DeNisco'
-author = u'John DeNisco'
+project = u'The Vector Packet Processor'
+copyright = u'2018-2021, Linux Foundation'
+author = u'FD.io VPP Community'
 
 # The short X.Y version
-version = u''
+version = subprocess.run(["git", "describe"], stdout=subprocess.PIPE, text=True).stdout
 # The full version, including alpha/beta/rc tags
-release = u'0.1'
+release = subprocess.run(["git", "describe", "--long"], stdout=subprocess.PIPE, text=True).stdout
 
 
 # -- General configuration ---------------------------------------------------
@@ -40,7 +42,13 @@ release = u'0.1'
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
-]
+    'recommonmark',
+    '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']
@@ -48,10 +56,11 @@ 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'
 
@@ -65,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'
@@ -79,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.
@@ -104,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']
 
+
 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.
@@ -148,7 +154,8 @@ latex_elements = {
 # (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'),
 ]
 
@@ -158,7 +165,8 @@ latex_documents = [
 # 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)
 ]
 
@@ -169,7 +177,8 @@ man_pages = [
 # (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'),
 ]