blob: 5fc51fe82707505cf9688f618666f17aa41b2a16 [file] [log] [blame]
Aric Gardnerf934b3d2019-09-23 13:06:27 -04001[tox]
2minversion = 2.0
3envlist =
4 docs,
5 docs-linkcheck,
6
7skipsdist = true
8
9[testenv:docs]
10basepython = python3
DW Talton1ab44942021-01-19 11:42:43 -070011deps =
Aric Gardnerf934b3d2019-09-23 13:06:27 -040012 sphinx
13 sphinx-rtd-theme
14 sphinxcontrib-httpdomain
15 recommonmark
16 lfdocs-conf
Jessica Wagantall9fcfa702023-05-10 17:22:34 -070017 urllib3~=1.26.15
18allowlist_externals = echo
Aric Gardnerf934b3d2019-09-23 13:06:27 -040019commands =
20 sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
Aric Gardner2f78ee02019-10-01 17:13:08 -040021
Aric Gardnerf934b3d2019-09-23 13:06:27 -040022 echo "Generated docs available in {toxinidir}/docs/_build/html"
Aric Gardner2f78ee02019-10-01 17:13:08 -040023
Aric Gardnerf934b3d2019-09-23 13:06:27 -040024whitelist_externals = echo
25
26[testenv:docs-linkcheck]
27basepython = python3
28deps = sphinx
29 sphinx-rtd-theme
30 sphinxcontrib-httpdomain
31 recommonmark
32 lfdocs-conf
Jessica Wagantall9fcfa702023-05-10 17:22:34 -070033 urllib3~=1.26.15
Aric Gardnerf934b3d2019-09-23 13:06:27 -040034commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck