diff options
author | 2018-09-18 11:02:09 -0400 | |
---|---|---|
committer | 2018-09-18 11:02:15 -0400 | |
commit | da30cab5f4d52037fa46a06347286d455000d8c7 (patch) | |
tree | be8d8e2fb97b4de0ae377b571fcfcde1df777019 /tox.ini | |
parent | bf2f1c7aa3491f683b1660de68876cf2731f64a4 (diff) |
Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
Change-Id: Ifb8fce66e59432863d042a96308e6c3a89fb11a8
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 |