3 envlist = docs,docs-linkcheck
9 -r{toxinidir}/etc/requirements-docs.txt
10 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
11 -c{toxinidir}/etc/upper-constraints.onap.txt
13 sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
14 echo "Generated docs available in {toxinidir}/docs/_build/html"
20 [testenv:docs-templates]
21 basepython = python3.8
23 -r{toxinidir}/etc/requirements-docs.txt
24 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
25 -c{toxinidir}/etc/upper-constraints.onap.txt
27 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
28 echo "Generated docs available in {toxinidir}/docs/_build/html/templates"
33 basepython = python3.8
35 -r{toxinidir}/etc/requirements-docs.txt
36 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
37 -c{toxinidir}/etc/upper-constraints.onap.txt
39 git submodule update --depth 100 --init
40 sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
41 echo "Generated docs available in {toxinidir}/docs/_build/html"
46 [testenv:docs-linkcheck]
47 basepython = python3.8
49 -r{toxinidir}/etc/requirements-docs.txt
50 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
51 -c{toxinidir}/etc/upper-constraints.onap.txt
52 commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
55 basepython = python3.8
57 -r{toxinidir}/etc/requirements-docs.txt
58 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
59 -c{toxinidir}/etc/upper-constraints.onap.txt
61 sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck
65 -r{toxinidir}/etc/requirements-docs.txt
66 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
67 -c{toxinidir}/etc/upper-constraints.onap.txt
69 autopep8 --max-line-length 120 --in-place docs/conf.py
73 -r{toxinidir}/etc/requirements-docs.txt
74 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
75 -c{toxinidir}/etc/upper-constraints.onap.txt
77 pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py