From 340c15c6ed34ce60c821b5260fec3eb11d65dcb7 Mon Sep 17 00:00:00 2001 From: Paul Vinciguerra Date: Tue, 5 Nov 2019 15:34:36 -0500 Subject: 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 --- docs/etc/requirements.txt | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/etc/requirements.txt') 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 -- cgit 1.2.3-korg