X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=tox.ini;h=1fdc85bea20de343ab1860bb84863a995492772e;hb=b0c6c0b98a4fefcd0b2c88102a06a61c5d624cd0;hp=4bc8f3d655627a83e0227b00ab043edc95151704;hpb=32d2daf4c1c9a01c6cc6e9b4218b9f4d2650b8e8;p=doc.git diff --git a/tox.ini b/tox.ini index 4bc8f3d65..1fdc85bea 100644 --- a/tox.ini +++ b/tox.ini @@ -4,10 +4,13 @@ envlist = docs,docs-linkcheck skipsdist = true [testenv:docs] -basepython = python3 -deps = -r{toxinidir}/etc/requirements.txt +basepython = python3.8 +deps = + -r{toxinidir}/etc/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -c{toxinidir}/etc/upper-constraints.onap.txt commands = - sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + 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 @@ -15,44 +18,60 @@ whitelist_externals = sh [testenv:docs-templates] -basepython = python3 -deps = -r{toxinidir}/etc/requirements.txt +basepython = python3.8 +deps = + -r{toxinidir}/etc/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.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 + sphinx-build -W -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 +basepython = python3.8 +deps = + -r{toxinidir}/etc/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -c{toxinidir}/etc/upper-constraints.onap.txt commands = git submodule update --depth 100 --init - sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + 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 [testenv:docs-linkcheck] -basepython = python3 -deps = -r{toxinidir}/etc/requirements.txt -commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck +basepython = python3.8 +deps = + -r{toxinidir}/etc/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -c{toxinidir}/etc/upper-constraints.onap.txt +commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck [testenv:spellcheck] -basepython = python3 +basepython = python3.8 deps = - -r{toxinidir}/etc/requirements.txt - sphinxcontrib-spelling + -r{toxinidir}/etc/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.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] -deps = autopep8 +deps = + -r{toxinidir}/etc/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -c{toxinidir}/etc/upper-constraints.onap.txt commands = autopep8 --max-line-length 120 --in-place docs/conf.py [testenv:pylint] -deps = pylint +deps = + -r{toxinidir}/etc/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -c{toxinidir}/etc/upper-constraints.onap.txt commands = pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py