tox.ini

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