docs: add spellcheck to 'make docs' sphinx docs 78/23278/3
authorPaul Vinciguerra <pvinci@vinciconsulting.com>
Tue, 5 Nov 2019 20:34:36 +0000 (15:34 -0500)
committerDave Barach <openvpp@barachs.net>
Wed, 6 Nov 2019 17:53:42 +0000 (17:53 +0000)
commit340c15c6ed34ce60c821b5260fec3eb11d65dcb7
treee791acb487279b7273cdbe753a2d46ccd982f5ea
parent4d11b6cecaa9c1be20aa149bc8779f197f6393ed
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>
18 files changed:
docs/Makefile
docs/conf.py
docs/etc/requirements.txt
docs/featuresbyrelease/vpp16.06.rst
docs/featuresbyrelease/vpp17.01.rst
docs/featuresbyrelease/vpp17.04.rst
docs/featuresbyrelease/vpp17.07.rst
docs/featuresbyrelease/vpp18.07.rst
docs/featuresbyrelease/vpp18.10.rst
docs/gettingstarted/developers/fib20/routes.rst
docs/gettingstarted/developers/fib20/tunnels.rst
docs/gettingstarted/developers/metadata.md
docs/gettingstarted/developers/vlib.md
docs/reference/vppvagrant/VagrantVMSetup.rst
docs/usecases/ConnectingVPC.rst
docs/usecases/contiv/K8s_Overview.md
docs/usecases/simpleperf/iperf3.rst
src/plugins/quic/quic_plugin.rst