| Jackie Huang | 1d5a75e | 2023-06-09 10:12:29 +0800 | [diff] [blame] | 1 | # documentation only |
| weichen | b6d2696 | 2019-11-04 01:43:18 -0500 | [diff] [blame] | 2 | [tox] |
| 3 | minversion = 2.0 |
| 4 | envlist = |
| 5 | docs, |
| 6 | docs-linkcheck, |
| weichen | b6d2696 | 2019-11-04 01:43:18 -0500 | [diff] [blame] | 7 | skipsdist = true |
| 8 | |
| 9 | [testenv:docs] |
| 10 | basepython = python3 |
| 11 | deps = |
| 12 | sphinx |
| 13 | sphinx-rtd-theme |
| 14 | sphinxcontrib-httpdomain |
| 15 | recommonmark |
| 16 | lfdocs-conf |
| Jackie Huang | 1d5a75e | 2023-06-09 10:12:29 +0800 | [diff] [blame] | 17 | urllib3~=1.26.15 |
| weichen | b6d2696 | 2019-11-04 01:43:18 -0500 | [diff] [blame] | 18 | |
| 19 | commands = |
| 20 | sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
| weichen | b6d2696 | 2019-11-04 01:43:18 -0500 | [diff] [blame] | 21 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| Jackie Huang | 1d5a75e | 2023-06-09 10:12:29 +0800 | [diff] [blame] | 22 | allowlist_externals = echo |
| weichen | b6d2696 | 2019-11-04 01:43:18 -0500 | [diff] [blame] | 23 | |
| 24 | [testenv:docs-linkcheck] |
| 25 | basepython = python3 |
| 26 | deps = sphinx |
| 27 | sphinx-rtd-theme |
| 28 | sphinxcontrib-httpdomain |
| 29 | recommonmark |
| 30 | lfdocs-conf |
| Jackie Huang | 1d5a75e | 2023-06-09 10:12:29 +0800 | [diff] [blame] | 31 | urllib3~=1.26.15 |
| weichen | b6d2696 | 2019-11-04 01:43:18 -0500 | [diff] [blame] | 32 | commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |