add a documentation spellchecker tox profile

inspired from openStack
https://github.com/openstack/qa-specs/blob/master/tox.ini

https://doughellmann.com/blog/tag/sphinxcontrib-spelling/
https://pypi.org/project/sphinxcontrib-spelling/

JIRA: TRNSPRTPCE-349
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: Ibaf9a74ab22f9aa60c656a3d5d5d955eecc68bbc

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
new file mode 100644 (file)
index 0000000..d069da5
--- /dev/null
+++ b/docs/spelling_wordlist.txt
@@ -0,0 +1,20 @@
+ACL
+datastore
+Gerrit
+Git
+Jenkins
+Karaf
+muxponder
+ODU
+OpenDaylight
+OpenFlow
+OpenROADM
+orchestrator
+OTN
+OTU
+ovs
+ovsdb
+releng
+Renderer
+TransportPCE
+Xponder

diff --git a/tox.ini b/tox.ini
index 24165a59d25142ae21e89ecdf9fd73eb14bdf51e..f365a14dfe31b1048323baca03848ea1dc614924 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -76,6 +76,14 @@ basepython = python3
 deps = -rdocs/requirements.txt
 commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/linkcheck
 
 deps = -rdocs/requirements.txt
 commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/linkcheck
 

+[testenv:spelling]
+basepython = python3
+deps =
+    -rdocs/requirements.txt
+    sphinxcontrib-spelling
+    PyEnchant
+commands = sphinx-build -b spelling  -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/spelling
+

 [testenv:autopep8]
 basepython = python3
 deps = autopep8
 [testenv:autopep8]
 basepython = python3
 deps = autopep8