X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=68dab302105b3dbc976ea13bfbdd91e70cdfae22;hb=87e64c929fa534ebd29b18f38fc6c15fd216e7e4;hp=1d60e29f1a70ef40cdc98d21fd34c9011b3a504a;hpb=ce96dda4478d8a9ee3e3a6646c3367eb20263e3f;p=vpp.git diff --git a/docs/conf.py b/docs/conf.py index 1d60e29f1a7..68dab302105 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,14 +18,14 @@ # -- Project information ----------------------------------------------------- -project = u'Vector Packet Processor' +project = u'The Vector Packet Processor' copyright = u'2018, Linux Foundation' author = u'John DeNisco' # The short X.Y version -version = u'' +version = u'master' # The full version, including alpha/beta/rc tags -release = u'1.0' +release = u'20.01' # -- General configuration --------------------------------------------------- @@ -40,18 +40,21 @@ release = u'1.0' extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', -] + 'recommonmark', + 'sphinxcontrib.spelling'] +spelling_word_list_filename = 'spelling_wordlist.txt' # Add any paths that contain templates here, relative to this directory. 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' @@ -104,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') @@ -148,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'), ] @@ -158,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) ] @@ -169,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'), ]