diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:01:48 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:01:55 -0400 |
| commit | 478dc53bfdda4aec04045302f1c3f822cbfc12a5 (patch) | |
| tree | 298736699f34366124861ae8f48298baa2c886af /tox.ini | |
| parent | b52c942a4fbfc5023780d23954de953b817c6dc0 (diff) | |
Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
Change-Id: Id07d11951e9fb4812737574884ff505bf536b221
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
diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..69aa1893 --- /dev/null +++ b/tox.ini @@ -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 |