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 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  10     echo "Generated docs available in {toxinidir}/docs/_build/html"
  11 whitelist_externals =
  12     echo
  13     git
  14     sh
  15
  16 [testenv:local]
  17 deps = -r{toxinidir}/etc/requirements.txt
  18 commands =
  19     git submodule update --depth 100 --init
  20     sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  21     echo "Generated docs available in {toxinidir}/docs/_build/html"
  22 whitelist_externals =
  23     echo
  24     git
  25
  26 [testenv:linkcheck]
  27 deps = -r{toxinidir}/etc/requirements.txt
  28 commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
  29
  30 [testenv:spellcheck]
  31 deps =
  32     -r{toxinidir}/etc/requirements.txt
  33     sphinxcontrib-spelling
  34 commands =
  35     sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck