docs/tox.ini

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