docs/tox.ini

   1 [tox]
   2 minversion = 1.6
   3 envlist = docs,docs-linkcheck,docs-spellcheck
   4 skipsdist = true
   5
   6 [testenv:docs]
   7 allowlist_externals =
   8     echo
   9     git
  10     sh
  11 basepython = python3.8
  12 deps =
  13     -r{toxinidir}/requirements-docs.txt
  14     -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
  15     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
  16 commands =
  17     sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
  18     echo "Generated docs available in {toxinidir}/_build/html"
  19
  20
  21 [testenv:docs-linkcheck]
  22 basepython = python3.8
  23 deps =
  24     -r{toxinidir}/requirements-docs.txt
  25     -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
  26     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
  27 commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
  28
  29 [testenv:docs-spellcheck]
  30 basepython = python3.8
  31 deps =
  32     -r{toxinidir}/requirements-docs.txt
  33     -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
  34     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
  35 commands = sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck