X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=tox.ini;h=ccedab79c6b5711e03ec58a6b8536441e65673f0;hb=bcba18a222a8bcf8d937a60436574426306dadae;hp=d94b1129b9c8aa60ab818fc1227921178f719c2f;hpb=9c3af50160a00efae37e8a397a046d1c786596f8;p=doc.git diff --git a/tox.ini b/tox.ini index d94b1129b..ccedab79c 100644 --- a/tox.ini +++ b/tox.ini @@ -1,32 +1,77 @@ [tox] minversion = 1.6 -envlist = docs +envlist = docs,docs-linkcheck skipsdist = true [testenv:docs] -deps = -r{toxinidir}/etc/requirements.txt +basepython = python3 +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 -j 4 -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 +whitelist_externals = + echo + git + sh + +[testenv:docs-templates] +basepython = python3 +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 + echo "Generated docs available in {toxinidir}/docs/_build/html/templates" +whitelist_externals = + echo [testenv:local] -deps = -r{toxinidir}/etc/requirements.txt +basepython = python3 +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 1 --init - sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + 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 -[testenv:linkcheck] -deps = -r{toxinidir}/etc/requirements.txt -commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck +[testenv:docs-linkcheck] +basepython = python3 +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 +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 spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck + +[testenv:autopep8] 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 ./docs/ {toxinidir}/docs/_build/spellcheck + -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 = + -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