tox.ini

   1 # documentation only
   2 [tox]
   3 minversion = 2.0
   4 envlist =
   5     docs,
   6     docs-linkcheck,
   7 skipsdist = true
   8
   9 [testenv:docs]
  10 basepython = python3
  11 deps =
  12     sphinx
  13     sphinx-rtd-theme
  14     sphinxcontrib-httpdomain
  15     recommonmark
  16     lfdocs-conf
  17
  18 commands =
  19     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  20     echo "Generated docs available in {toxinidir}/docs/_build/html"
  21 whitelist_externals = echo
  22
  23 [testenv:docs-linkcheck]
  24 basepython = python3
  25 deps = sphinx
  26        sphinx-rtd-theme
  27        sphinxcontrib-httpdomain
  28        recommonmark
  29        lfdocs-conf
  30 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck