tox.ini

   1 [tox]
   2 minversion = 1.6
   3 envlist = docs
   4 skipsdist = true
   5
   6 [testenv:docs]
   7 basepython = python3
   8 deps = -r{toxinidir}/etc/requirements.txt
   9 commands =
  10     sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  11     echo "Generated docs available in {toxinidir}/docs/_build/html"
  12 whitelist_externals =
  13     echo
  14     git
  15     sh
  16
  17 [testenv:local]
  18 basepython = python3
  19 deps = -r{toxinidir}/etc/requirements.txt
  20 commands =
  21     git submodule update --depth 100 --init
  22     sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  23     echo "Generated docs available in {toxinidir}/docs/_build/html"
  24 whitelist_externals =
  25     echo
  26     git
  27
  28 [testenv:linkcheck]
  29 basepython = python3
  30 deps = -r{toxinidir}/etc/requirements.txt
  31 commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
  32
  33 [testenv:spellcheck]
  34 basepython = python3
  35 deps =
  36     -r{toxinidir}/etc/requirements.txt
  37     sphinxcontrib-spelling
  38 commands =
  39     sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck