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 = -r{toxinidir}/docs/requirements-docs.txt
  12
  13 commands =
  14     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  15     echo "Generated docs available in {toxinidir}/docs/_build/html"
  16 allowlist_externals = echo
  17
  18 [testenv:docs-linkcheck]
  19 basepython = python3
  20 deps = -r{toxinidir}/docs/requirements-docs.txt
  21 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck