[tox]
minversion = 1.6
-envlist = docs,docs-linkcheck
+envlist = docs,docs-linkcheck,docs-spellcheck
skipsdist = true
[testenv:docs]
-basepython = python3
+basepython = python3.8
deps =
- -r{toxinidir}/etc/requirements.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
commands =
- sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
- echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals =
- echo
- git
- sh
-
-[testenv:docs-templates]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- sphinx-build -b html -n -d {envtmpdir}/doctrees -c {toxinidir}/docs ./docs/guides/onap-developer/how-to-use-docs/templates {toxinidir}/docs/_build/html/templates
- echo "Generated docs available in {toxinidir}/docs/_build/html/templates"
-whitelist_externals =
- echo
-
-[testenv:local]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- git submodule update --depth 100 --init
- sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
- echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals =
- echo
- git
+ sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
[testenv:docs-linkcheck]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
-
-[testenv:spellcheck]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck
-
-[testenv:autopep8]
+basepython = python3.8
deps =
- -r{toxinidir}/etc/requirements.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
commands =
- autopep8 --max-line-length 120 --in-place docs/conf.py
+ sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
-[testenv:pylint]
+[testenv:docs-spellcheck]
+basepython = python3.8
deps =
- -r{toxinidir}/etc/requirements.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
commands =
- pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py
+ sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
\ No newline at end of file