diff options
author | Aric Gardner <agardner@linuxfoundation.org> | 2018-09-27 14:25:00 -0400 |
---|---|---|
committer | Gergely Csatari <gergely.csatari@nokia.com> | 2018-09-28 08:17:15 +0200 |
commit | 63c1d0f1b1dfc5b64f9b50f20a55e7dcc5d8ca5b (patch) | |
tree | 6b40213f2d8fb3ba26cf278ff0fbe11ae34569a0 /tox.ini | |
parent | 364189da11e212f238db091ff98a016318bcb4f3 (diff) |
Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
Change-Id: If60809816322a1dbf0e6b9ef5f4a14db491f7a1e
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'tox.ini')
-rw-r--r-- | tox.ini | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -0,0 +1,19 @@ +[tox] +minversion = 1.6 +envlist = + docs, + docs-linkcheck +skipsdist = true + +[testenv:docs] +deps = -rdocs/requirements.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +deps = -rdocs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck + + |