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 allowlist_externals = echo
  19
  20 commands =
  21     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  22     echo "Generated docs available in {toxinidir}/docs/_build/html"
  23
  24 [testenv:docs-linkcheck]
  25 basepython = python3
  26 deps = sphinx
  27        sphinx-rtd-theme
  28        sphinxcontrib-httpdomain
  29        recommonmark
  30        lfdocs-conf
  31        urllib3~=1.26.15
  32 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
  33
  34 [testenv:clm]
  35 # use pip to report dependencies with versions
  36 whitelist_externals = sh
  37 commands = sh -c 'pip freeze > requirements.txt'