Enforce Spellchecker in CI

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I7b4d8e69045b730fb9c59decae29922268564fa3
(cherry picked from commit c1f65083c009e092abd86a588350bc8d79ee2511)

diff --git a/docs/conf.py b/docs/conf.py
index cb9acd9b4213358d34bc413bd03f4c4c7d3fa433..d21ca7acdb878ef28bc6a8002bc3407763540675 100755 (executable)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -77,6 +77,8 @@ linkcheck_timeout = 300
 nitpicky = True
 release = version
 
+spelling_warning=True
+
 html_context = {
     'version_status': 'supported',
 }

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
index 8fe3f9c51cef98d04992f327c50c3d71d97beb4d..1f5883a3c8d5b44aa2a397e255e404e0c9df1141 100644 (file)
--- a/docs/spelling_wordlist.txt
+++ b/docs/spelling_wordlist.txt
@@ -1,34 +1,38 @@
+aaa
+abelur
 ACL
+aggregator
+akka
 Akka
 Aluminium
-Asciidoc
-Async
-Autorelease
+analytics
 artefacts
+Asciidoc
 async
+Async
 augmentable
 autorelease
-aaa
-abelur
-akka
-analytics
-BigInteger
+Autorelease
 bgpcep
-bugfixes
+BigInteger
 boolean
+breakpoint
+bugfixes
+Bulleted
 bytecode
-Checkstyle
 catalogue
+checkbox
+Checkstyle
 closeable
 codebase
 codec
 codecs
+committer
+Committer
 committers
 config
 configurator
 Daexim
-Disruptor
-DOM
 dataplane
 datastore
 datastores
@@ -37,101 +41,121 @@ dependant
 deserialization
 deserialize
 dev
+Disruptor
+DOM
 downloader
-EPL
 eg
+EPL
 executer
 extendibility
+functionalities
 Gerrit
+getters
 Git
-Guice
+google
 GPG
-getters
+Guice
 Hamcrest
 hardcoded
 helpdesk
 hostname
+IDE
 ietf
 impactful
 infrautils
 instantiation
+interoperability
 intra
-JIT
-JVM
+IP
+IPv
+jamoluhrsen
+jarfile
 Javadoc
 Jenkins
 Jira
-JUnit
-jamoluhrsen
-jarfile
+JIT
 judgement
-Karaf
+JUnit
+JVM
 karaf
+Karaf
 keyed
-Logback
 lftools
 linter
+Logback
+logins
 Magnesium
-Mockito
-Netty
 mdsal
+metadata
 microservice
 microservices
 millis
 mitigation
 mitigations
+Mockito
+multi
+Multi
 muxponders
 namespace
 namespaces
-netvirt
 netconf
+Netty
+netvirt
 nitty
+occurance
+odlparent
 OpenDaylight
 OpenFlow
 OpenStack
-occurance
-odlparent
+optimizations
 overline
 ovs
 ovsdb
-PCE
+parameterized
 Pax
+PCE
 pre
 QoS
-Resolvers
-Runtime
-reStructuredText
 reachability
 rebase
 rebases
 rebasing
 reconfigurable
 reconnection
+refactor
+refactoring
 referenceable
 reimplemented
-remediations
 releng
+remediations
 renderer
+Resolvers
+reStructuredText
 rethrow
 rovarga
 runtime
-Shiro
+Runtime
+Scala
 scalability
+screenshots
+Shiro
+startup
 stateful
+subclasses
 submodule
 submodules
-subclasses
 subnet
 subtypes
 superclass
 switchponders
 syntaxes
 TCP
-TSC
-Trie
+Timeline
 todo
 tox
+Trie
 tsc
+TSC
 typeless
 uint
 uncheck
@@ -139,10 +163,14 @@ unkeyed
 unreachability
 untrusted
 uploader
+username
 variadic
-vTEP
+versioned
+versioning
 virtualenv
+virtualization
+vTEP
 whitespace
-yangtools
 Xerces
 xml
+yangtools

diff --git a/tox.ini b/tox.ini
index 7018fdf3dc56eb74240831efcc01ce0a088ee9d8..666c4cfc872e5e51769fe801d63968904b94d3ea 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -1,6 +1,6 @@
 [tox]
 minversion = 1.6
-envlist = pre-commit,gitlint,docs,docs-linkcheck
+envlist = pre-commit,gitlint,docs,docs-linkcheck,spelling
 skipsdist = true
 
 [testenv:docs]
@@ -53,5 +53,8 @@ deps =
     -rdocs/requirements.txt
     sphinxcontrib-spelling
     PyEnchant
-commands = sphinx-build -b spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spelling
+whitelist_externals = sh
+commands =
+    sh -c 'command enchant>/dev/null || sudo yum -y install enchant || (echo "enchant command not found - please install it (e.g. sudo apt-get install enchant | yum install enchant )" >&2 && exit 1)'
+    sphinx-build -q -W -b spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spelling