diff options
author | Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:05:55 -0400 |
---|---|---|
committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:06:01 -0400 |
commit | d2b2482561359abaeed12b77ccd8ad4418dffd8a (patch) | |
tree | 670a8aaeeaf83f922f59a33bb3c65eda915a5fd9 /tox.ini | |
parent | d65e22d27ab305d38059046dae60d7a66ff4a4e0 (diff) |
Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
Change-Id: I68d939d6b1c7e27fc5d266d0934e355560ee7748
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 |