diff options
author | Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:03:48 -0400 |
---|---|---|
committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:03:55 -0400 |
commit | 54c5333ac4217a3fcd9c9142c8132b8fec0dd2fa (patch) | |
tree | 2e308bb554f97e84d7859f97a507d7b56e1820a7 /tox.ini | |
parent | a0f1cb6d759679e66d6da7fcd0471ddca22b5b6f (diff) |
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
Change-Id: I79094867657cda83c231949c52ba9eee1cd54eeb
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'tox.ini')
-rw-r--r-- | tox.ini | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -0,0 +1,17 @@ +[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 |