X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=tox.ini;h=ad85799d31868e63e2301b675bfa31d2961f0419;hb=d2276d54689c0136386dc575bc595edbae3249e2;hp=ee12e8ea750cc4a09155fb84d7ede57cc393d276;hpb=d9bd8e78a8220ed2c0ff5c09892aa341bdaa6b65;p=docs.git

diff --git a/tox.ini b/tox.ini
index ee12e8ea7..ad85799d3 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,8 +1,60 @@
 [tox]
 minversion = 1.6
-envlist = docs
+envlist = pre-commit,gitlint,docs,docs-linkcheck,spelling
 skipsdist = true
 
 [testenv:docs]
-deps = sphinx
-commands = sphinx-build -b html -d {envtmpdir}/doctrees ./docs/ {envtmpdir}/html
+basepython = python3
+deps = -rdocs/requirements.txt
+commands =
+    sphinx-build -q -j auto -W --keep-going -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+
+[testenv:docs-linkcheck]
+basepython = python3
+deps = -rdocs/requirements.txt
+commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+
+[testenv:pre-commit-install]
+basepython = python3
+deps = pre-commit
+commands =
+    pre-commit install
+    pre-commit install --hook-type commit-msg
+
+[testenv:pre-commit-uninstall]
+basepython = python3
+deps = pre-commit
+commands =
+    pre-commit uninstall
+    pre-commit uninstall --hook-type commit-msg
+
+[testenv:pre-commit]
+basepython = python3
+deps = pre-commit
+passenv = HOME
+commands =
+    pre-commit run --all-files --show-diff-on-failure
+    pre-commit run gitlint --hook-stage commit-msg --commit-msg-filename .git/COMMIT_EDITMSG
+    # Gitlint only proposes a pre-commit configuration for the commit-msg stage but none for the commit stage.
+    # Its default arguments --passed and --msg-filename are different from CI recommandations.
+    # As a result, the line above is skipped in jenkins CI since there cannot be a .git/COMMIT_EDITMSG file
+    # and the HOME variable must be passed to tox virtualenv so that Gitlint can access the git user configuration.
+    # A dedicated gitlint profile for CI is proposed below.
+
+[testenv:gitlint]
+basepython = python3
+deps = gitlint
+commands =
+    gitlint
+
+[testenv:spelling]
+basepython = python3
+deps =
+    -rdocs/requirements.txt
+    sphinxcontrib-spelling
+    PyEnchant
+whitelist_externals = sh
+commands =
+    sh -c 'command enchant>/dev/null || command enchant-2 -v>/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 --keep-going -b spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spelling
+