X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=da8c223f27a1f9db2b193ad0d9baf59caaff6d02;hb=61717cc38;hp=f3332c9a2c58bbcb04ba3eb650560dfca766354a;hpb=3bfeff7a9812c025637ee232cca03a6f083bdbc6;p=vpp.git diff --git a/docs/conf.py b/docs/conf.py index f3332c9a2c5..da8c223f27a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,14 +18,14 @@ # -- Project information ----------------------------------------------------- -project = u'Vector Packet Processor' -copyright = u'2018, Linux Foundation' +project = u'The Vector Packet Processor' +copyright = u'2018-2020, 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 -release = u'01' +release = u'20.01' # -- General configuration --------------------------------------------------- @@ -41,9 +41,9 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'recommonmark', - 'sphinx_markdown_tables' -] + 'sphinxcontrib.spelling'] +spelling_word_list_filename = 'spelling_wordlist.txt' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -53,7 +53,7 @@ templates_path = ['_templates'] source_suffix = { '.rst': 'restructuredtext', '.md': 'markdown' - } +} # The master toctree document. master_doc = 'index' @@ -107,6 +107,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'] + def setup(app): app.add_stylesheet('css/rules.css') @@ -151,7 +152,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'), ] @@ -161,7 +163,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) ] @@ -172,7 +175,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'), ]