| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 1 | [tox] |
| 2 | minversion = 1.6 |
| Guillaume Lambert | 723363b | 2021-02-02 14:15:40 +0100 | [diff] [blame] | 3 | envlist = docs,docs-linkcheck |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 4 | skipsdist = true |
| 5 | |
| 6 | [testenv:docs] |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 7 | basepython = python3.8 |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 8 | deps = |
| thmsdt | ae619be | 2021-12-20 13:32:38 +0100 | [diff] [blame] | 9 | -r{toxinidir}/etc/requirements-docs.txt |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 10 | -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 11 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 12 | commands = |
| Guillaume Lambert | dbf9177 | 2021-04-23 11:14:34 +0200 | [diff] [blame] | 13 | sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 14 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| Rich Bennett | 169c134 | 2018-11-02 06:47:43 -0400 | [diff] [blame] | 15 | whitelist_externals = |
| 16 | echo |
| 17 | git |
| 18 | sh |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 19 | |
| Andrea Visnyei | 32d2daf | 2020-12-09 12:26:35 +0100 | [diff] [blame] | 20 | [testenv:docs-templates] |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 21 | basepython = python3.8 |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 22 | deps = |
| thmsdt | ae619be | 2021-12-20 13:32:38 +0100 | [diff] [blame] | 23 | -r{toxinidir}/etc/requirements-docs.txt |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 24 | -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 25 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| Andrea Visnyei | 32d2daf | 2020-12-09 12:26:35 +0100 | [diff] [blame] | 26 | commands = |
| Cédric Ollivier | 8c7dee9 | 2023-02-18 17:59:24 +0100 | [diff] [blame] | 27 | 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 |
| Andrea Visnyei | 32d2daf | 2020-12-09 12:26:35 +0100 | [diff] [blame] | 28 | echo "Generated docs available in {toxinidir}/docs/_build/html/templates" |
| 29 | whitelist_externals = |
| 30 | echo |
| 31 | |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 32 | [testenv:local] |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 33 | basepython = python3.8 |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 34 | deps = |
| thmsdt | ae619be | 2021-12-20 13:32:38 +0100 | [diff] [blame] | 35 | -r{toxinidir}/etc/requirements-docs.txt |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 36 | -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 37 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 38 | commands = |
| Hagop Bozawglanian | 4cc3e88 | 2019-09-04 21:17:28 +0000 | [diff] [blame] | 39 | git submodule update --depth 100 --init |
| Guillaume Lambert | dbf9177 | 2021-04-23 11:14:34 +0200 | [diff] [blame] | 40 | sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 41 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| 42 | whitelist_externals = |
| 43 | echo |
| 44 | git |
| 45 | |
| Aric Gardner | dd7413d | 2020-02-05 13:15:34 -0500 | [diff] [blame] | 46 | [testenv:docs-linkcheck] |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 47 | basepython = python3.8 |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 48 | deps = |
| thmsdt | ae619be | 2021-12-20 13:32:38 +0100 | [diff] [blame] | 49 | -r{toxinidir}/etc/requirements-docs.txt |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 50 | -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 51 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| Cédric Ollivier | 2d2241a | 2022-07-05 14:49:25 +0200 | [diff] [blame] | 52 | commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |
| Rich Bennett | 9c3af50 | 2018-04-26 09:30:57 -0400 | [diff] [blame] | 53 | |
| 54 | [testenv:spellcheck] |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 55 | basepython = python3.8 |
| Rich Bennett | 9c3af50 | 2018-04-26 09:30:57 -0400 | [diff] [blame] | 56 | deps = |
| thmsdt | ae619be | 2021-12-20 13:32:38 +0100 | [diff] [blame] | 57 | -r{toxinidir}/etc/requirements-docs.txt |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 58 | -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 59 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| Guillaume Lambert | 723363b | 2021-02-02 14:15:40 +0100 | [diff] [blame] | 60 | commands = |
| Guillaume Lambert | 1abd85a | 2021-02-10 11:21:02 +0100 | [diff] [blame] | 61 | sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck |
| Guillaume Lambert | 9015be3 | 2021-02-17 11:46:10 +0100 | [diff] [blame] | 62 | |
| 63 | [testenv:autopep8] |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 64 | deps = |
| thmsdt | ae619be | 2021-12-20 13:32:38 +0100 | [diff] [blame] | 65 | -r{toxinidir}/etc/requirements-docs.txt |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 66 | -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 67 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| Guillaume Lambert | 9015be3 | 2021-02-17 11:46:10 +0100 | [diff] [blame] | 68 | commands = |
| 69 | autopep8 --max-line-length 120 --in-place docs/conf.py |
| 70 | |
| 71 | [testenv:pylint] |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 72 | deps = |
| thmsdt | ae619be | 2021-12-20 13:32:38 +0100 | [diff] [blame] | 73 | -r{toxinidir}/etc/requirements-docs.txt |
| Cédric Ollivier | b0ba1fe | 2022-08-31 20:12:06 +0200 | [diff] [blame] | 74 | -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt |
| Cédric Ollivier | ee3abf1 | 2021-09-28 13:48:21 +0200 | [diff] [blame] | 75 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| Guillaume Lambert | 9015be3 | 2021-02-17 11:46:10 +0100 | [diff] [blame] | 76 | commands = |
| 77 | pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py |