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