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     urllib3~=1.26.15
  22
  23 commands =
  24     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  25     echo "Generated docs available in {toxinidir}/docs/_build/html"
  26 allowlist_externals = echo
  27
  28 [testenv:docs-linkcheck]
  29 passenv =
  30   http_proxy
  31   https_proxy
  32
  33 basepython = python3
  34 deps = sphinx
  35        sphinx-rtd-theme
  36        sphinxcontrib-httpdomain
  37        recommonmark
  38        lfdocs-conf
  39        urllib3~=1.26.15
  40 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck