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