blob: a2250a7d2a1b9a6bd863a15be862e233460857bd [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
DW Talton1ab44942021-01-19 11:42:43 -070017
Aric Gardnerf934b3d2019-09-23 13:06:27 -040018commands =
19 sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
Aric Gardner2f78ee02019-10-01 17:13:08 -040020
Aric Gardnerf934b3d2019-09-23 13:06:27 -040021 echo "Generated docs available in {toxinidir}/docs/_build/html"
Aric Gardner2f78ee02019-10-01 17:13:08 -040022
Aric Gardnerf934b3d2019-09-23 13:06:27 -040023whitelist_externals = echo
24
25[testenv:docs-linkcheck]
26basepython = python3
27deps = sphinx
28 sphinx-rtd-theme
29 sphinxcontrib-httpdomain
30 recommonmark
31 lfdocs-conf
32commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck