tox.ini

   1 [tox]
   2 minversion = 1.6
   3 envlist = pre-commit,docs,docs-linkcheck,spelling,gitlint
   4 skipsdist = true
   5
   6 [testenv:docs]
   7 basepython = python3
   8 deps = -rdocs/requirements.txt
   9 commands =
  10     sphinx-build -q -j auto -W --keep-going -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  11
  12 [testenv:docs-linkcheck]
  13 basepython = python3
  14 deps = -rdocs/requirements.txt
  15 commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
  16
  17 [testenv:pre-commit-install]
  18 basepython = python3
  19 deps = pre-commit
  20 commands =
  21     pre-commit install
  22     pre-commit install --hook-type commit-msg
  23
  24 [testenv:pre-commit-uninstall]
  25 basepython = python3
  26 deps = pre-commit
  27 commands =
  28     pre-commit uninstall
  29     pre-commit uninstall --hook-type commit-msg
  30
  31 [testenv:pre-commit-autoupdate]
  32 basepython = python3
  33 deps = pre-commit
  34 commands =
  35     pre-commit autoupdate
  36
  37 [testenv:pre-commit]
  38 basepython = python3
  39 deps = pre-commit
  40 passenv = HOME
  41 commands =
  42     pre-commit run --all-files --show-diff-on-failure
  43 # CI minions last upgrade makes pre-commit gitlint deps resolution fail.
  44 # until it is fixed, let's use native tox profile instead
  45 #    pre-commit run gitlint-ci --hook-stage manual
  46
  47 [testenv:gitlint]
  48 basepython = python3
  49 deps = gitlint
  50 commands =
  51     gitlint
  52
  53 [testenv:spelling]
  54 basepython = python3
  55 deps =
  56     -rdocs/requirements.txt
  57     sphinxcontrib-spelling
  58     PyEnchant
  59 allowlist_externals = sh
  60 commands =
  61     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)'
  62     sphinx-build -q -W --keep-going -b spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spelling
  63