blob: 18bbdaa06bfb61519f00beb74d5d1f7b3cd2c9fd [file] [log] [blame]
Mohamed Abukarb980c9a2019-12-02 11:22:22 +02001# documentation only
2[tox]
3minversion = 2.0
4envlist =
5 docs,
6 docs-linkcheck,
7skipsdist = true
8
9[testenv:docs]
10passenv =
11 http_proxy
12 https_proxy
13
14basepython = python3
15deps =
16 sphinx
17 sphinx-rtd-theme
18 sphinxcontrib-httpdomain
19 recommonmark
20 lfdocs-conf
czichy6b449f92023-09-01 09:24:01 +030021 urllib3~=1.26.15
Mohamed Abukarb980c9a2019-12-02 11:22:22 +020022
23commands =
24 sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
25 echo "Generated docs available in {toxinidir}/docs/_build/html"
czichy6b449f92023-09-01 09:24:01 +030026allowlist_externals = echo
Mohamed Abukarb980c9a2019-12-02 11:22:22 +020027
28[testenv:docs-linkcheck]
29passenv =
30 http_proxy
31 https_proxy
32
33basepython = python3
34deps = sphinx
35 sphinx-rtd-theme
36 sphinxcontrib-httpdomain
37 recommonmark
38 lfdocs-conf
czichy6b449f92023-09-01 09:24:01 +030039 urllib3~=1.26.15
Mohamed Abukarb980c9a2019-12-02 11:22:22 +020040commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck