diff options
| author |   Paul Vinciguerra <pvinci@vinciconsulting.com> | 2019-11-05 15:34:36 -0500 |
|---|---|---|
| committer |   Dave Barach <openvpp@barachs.net> | 2019-11-06 17:53:42 +0000 |
| commit | 340c15c6ed34ce60c821b5260fec3eb11d65dcb7 (patch) | |
| tree | e791acb487279b7273cdbe753a2d46ccd982f5ea /docs/etc | |
| parent | 4d11b6cecaa9c1be20aa149bc8779f197f6393ed (diff) | |
docs: add spellcheck to 'make docs' sphinx docs
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>
Diffstat (limited to 'docs/etc')
| -rw-r--r-- | docs/etc/requirements.txt | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/etc/requirements.txt b/docs/etc/requirements.txt index 660fc6cc882..b8b69bba966 100644 --- a/docs/etc/requirements.txt +++ b/docs/etc/requirements.txt @@ -27,4 +27,5 @@ sphinxcontrib-htmlhelp==1.0.2 sphinxcontrib-jsmath==1.0.1 sphinxcontrib-qthelp==1.0.2 sphinxcontrib-serializinghtml==1.1.3 +sphinxcontrib-spelling==4.3.0 urllib3==1.24.3 |