[tox]
minversion = 1.6
-envlist = docs,
-# docs-linkcheck,
-
+envlist = docs,docs-linkcheck,docs-spellcheck
skipsdist = true
[testenv:docs]
-basepython = python3
-deps = -r{toxinidir}/../etc/requirements.txt
+basepython = python3.8
+deps =
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://releases.openstack.org/constraints/upper/yoga
+ -c{toxinidir}/../etc/upper-constraints.onap.txt
commands =
- sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
- echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals =
- echo
+ sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
+allowlist_externals =
git
sh
-[testenv:local]
-basepython = python3
-deps = -r{toxinidir}/../etc/requirements.txt
-commands =
- git submodule update --depth 100 --init
- sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
- echo "Generated docs available in {toxinidir}/_build/html"
-whitelist_externals =
- echo
- git
-
[testenv:docs-linkcheck]
-basepython = python3
-deps = -r{toxinidir}/../etc/requirements.txt
-commands = echo "Link Checking not enforced"
-#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
-whitelist_externals =
- echo
+basepython = python3.8
+deps =
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://releases.openstack.org/constraints/upper/yoga
+ -c{toxinidir}/../etc/upper-constraints.onap.txt
+commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
-[testenv:spellcheck]
-basepython = python3
+[testenv:docs-spellcheck]
+basepython = python3.8
deps =
- -r{toxinidir}/../etc/requirements.txt
- sphinxcontrib-spelling
-commands =
- sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./ {toxinidir}/_build/spellcheck
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://releases.openstack.org/constraints/upper/yoga
+ -c{toxinidir}/../etc/upper-constraints.onap.txt
+commands =
+ sphinx-build -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck