ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add spellcheck to 'make docs' sphinx docs

Browse Source 
The CI gate will fail if there are typos in the docs.

  writing output... [ 21%] events/Summits/OpensourceSummit...
  writing output... [ 22%] events/Summits/UKNO/2017_04_30_...

  featuresbyrelease/vpp16.06.rst:34:Rasberry:vpp16.06
  writing output... [100%] usecases/vppinazure
  Spelling checker messages written to /vpp/docs/_build/html/output.txt

  Warning, treated as error:
  Found 1 misspelled words
  Makefile:31: recipe for target 'html' failed
  make[1]: *** [html] Error 2
  make[1]: Leaving directory '/vpp/docs'

If you introduce a term that is not recognized,
please add it to custom dictionary at
docs/spelling_wordlist.txt.

Type: feature

Change-Id: Id49be4fbee617f544f1ab8e78e7de8a4df36448b
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
This commit is contained in:
Paul Vinciguerra
2019-11-05 15:34:36 -05:00
committed by Dave Barach
parent 4d11b6ceca
commit 340c15c6ed
18 changed files with 92 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/conf.py
View File

@ -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'),
]