docs: add spellcheck to 'make docs' sphinx docs

[vpp.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index e9d7bb8..eb66cb3 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -41,8 +41,9 @@ 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']
 
@@ -52,7 +53,7 @@ templates_path = ['_templates']
 source_suffix = {
     '.rst': 'restructuredtext',
     '.md': 'markdown'
-    }
+}
 
 # The master toctree document.
 master_doc = 'index'
@@ -106,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')
 
@@ -150,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'),
 ]
 
@@ -160,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)
 ]
 
@@ -171,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'),
 ]