diff options
author | Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:02:33 -0400 |
---|---|---|
committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:02:40 -0400 |
commit | 45445fed30e2641ef53b7cfb2fd6b3b1ca3524d0 (patch) | |
tree | ce59824d239d0646f728b15ebf64ec35056a1201 /tox.ini | |
parent | 3de127959e70d9ec1c97e78af7b3a047a2ed7669 (diff) |
Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
Change-Id: I143b0c116d54f0cc864a73829fe240f5a139bbc1
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 |