tox.ini

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