| Jessica Wagantall | d4c19a9 | 2020-02-06 14:52:21 -0800 | [diff] [blame] | 1 | [tox] |
| 2 | minversion = 1.6 |
| Vijay Venkatesh Kumar | 958df7b | 2022-11-01 12:02:45 -0400 | [diff] [blame] | 3 | envlist = docs,docs-linkcheck,docs-spellcheck |
| Jessica Wagantall | d4c19a9 | 2020-02-06 14:52:21 -0800 | [diff] [blame] | 4 | skipsdist = true |
| 5 | |
| 6 | [testenv:docs] |
| Cédric Ollivier | e1930a6 | 2022-08-31 21:23:18 +0200 | [diff] [blame] | 7 | basepython = python3.8 |
| Eric Debeau | ea5c42a | 2021-09-29 21:28:28 +0200 | [diff] [blame] | 8 | deps = |
| 9 | -r{toxinidir}/requirements-docs.txt |
| Cédric Ollivier | e1930a6 | 2022-08-31 21:23:18 +0200 | [diff] [blame] | 10 | -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt |
| Vijay Venkatesh Kumar | 958df7b | 2022-11-01 12:02:45 -0400 | [diff] [blame] | 11 | -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master |
| 12 | commands = |
| Jessica Wagantall | d4c19a9 | 2020-02-06 14:52:21 -0800 | [diff] [blame] | 13 | sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html |
| 14 | echo "Generated docs available in {toxinidir}/_build/html" |
| Vijay Venkatesh Kumar | 958df7b | 2022-11-01 12:02:45 -0400 | [diff] [blame] | 15 | #commands = sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html |
| 16 | |
| Jessica Wagantall | d4c19a9 | 2020-02-06 14:52:21 -0800 | [diff] [blame] | 17 | whitelist_externals = |
| 18 | echo |
| 19 | git |
| 20 | sh |
| Vijay Venkatesh Kumar | 958df7b | 2022-11-01 12:02:45 -0400 | [diff] [blame] | 21 | |
| Jessica Wagantall | d4c19a9 | 2020-02-06 14:52:21 -0800 | [diff] [blame] | 22 | [testenv:docs-linkcheck] |
| Cédric Ollivier | e1930a6 | 2022-08-31 21:23:18 +0200 | [diff] [blame] | 23 | basepython = python3.8 |
| Eric Debeau | ea5c42a | 2021-09-29 21:28:28 +0200 | [diff] [blame] | 24 | deps = |
| 25 | -r{toxinidir}/requirements-docs.txt |
| Cédric Ollivier | e1930a6 | 2022-08-31 21:23:18 +0200 | [diff] [blame] | 26 | -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt |
| Vijay Venkatesh Kumar | 958df7b | 2022-11-01 12:02:45 -0400 | [diff] [blame] | 27 | -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master |
| 28 | commands = echo "Link Checking not enforced" |
| 29 | #commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck |
| 30 | |
| 31 | [testenv:docs-spellcheck] |
| 32 | basepython = python3.8 |
| 33 | deps = |
| 34 | -r{toxinidir}/requirements-docs.txt |
| 35 | -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt |
| 36 | -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master |
| 37 | #commands = echo "Spell Check not enforced" |
| 38 | commands = sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck |