X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=tox.ini;h=d44493e52100e25ab97c9feb780c681702e133db;hb=a71a80197dd1ab92f0171852b40e7277e5d520b5;hp=90be6828eabbb8dbc49316526ea4c078cc69ff57;hpb=4c4821172219b0bdf8fb8f5b60389be90ef6240a;p=docs.git diff --git a/tox.ini b/tox.ini index 90be6828e..d44493e52 100644 --- a/tox.ini +++ b/tox.ini @@ -1,15 +1,61 @@ [tox] minversion = 1.6 -envlist = docs,docs-linkcheck +envlist = pre-commit,docs,docs-linkcheck,spelling skipsdist = true [testenv:docs] -deps = -rrequirements.txt +basepython = python3 +deps = -rdocs/requirements.txt commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html - echo "Generated docs available in {toxinidir}/docs/_build/html" -whitelist_externals = echo + sphinx-build -q -j auto -W --keep-going -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html [testenv:docs-linkcheck] -deps = -rrequirements.txt -commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/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-autoupdate] +basepython = python3 +deps = pre-commit +commands = + pre-commit autoupdate + +[testenv:pre-commit] +basepython = python3 +deps = pre-commit +passenv = HOME +commands = + pre-commit run --all-files --show-diff-on-failure + pre-commit run gitlint-ci --hook-stage manual + +[testenv:gitlint] +basepython = python3 +deps = gitlint +commands = + gitlint + +[testenv:spelling] +basepython = python3 +deps = + -rdocs/requirements.txt + sphinxcontrib-spelling + PyEnchant +allowlist_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 +