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 passenv =
  11    http_proxy
  12    https_proxy
  13
  14 basepython = python3
  15 deps =
  16     sphinx
  17     sphinx-rtd-theme
  18     sphinxcontrib-httpdomain
  19     recommonmark
  20     lfdocs-conf
  21
  22 commands =
  23     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  24     echo "Generated docs available in {toxinidir}/docs/_build/html"
  25 whitelist_externals = echo
  26
  27 [testenv:docs-linkcheck]
  28 passenv =
  29    http_proxy
  30    https_proxy
  31
  32 basepython = python3
  33 deps = sphinx
  34        sphinx-rtd-theme
  35        sphinxcontrib-httpdomain
  36        recommonmark
  37        lfdocs-conf
  38 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck