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     sh {toxinidir}/shell/smsummary.sh  {toxinidir}/docs/_static/smsummary.out
  10     echo "Summary of submodule versions used in html build in {toxinidir}/docs/_static/smsummary.out"
  11     sphinx-build -j 3 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  12     echo "Generated docs available in {toxinidir}/docs/_build/html"
  13 whitelist_externals =
  14     echo
  15     git
  16     sh
  17
  18 [testenv:local]
  19 deps = -r{toxinidir}/etc/requirements.txt
  20 commands =
  21     git submodule update --depth 1 --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 deps = -r{toxinidir}/etc/requirements.txt
  30 commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
  31
  32 [testenv:spellcheck]
  33 deps =
  34     -r{toxinidir}/etc/requirements.txt
  35     sphinxcontrib-spelling
  36 commands =
  37     sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck