diff options
author | Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-09-05 22:35:42 -0700 |
---|---|---|
committer | Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-09-05 22:57:09 -0700 |
commit | ba638f983a4247e8bcf53e590b5e39e5016d6278 (patch) | |
tree | 6bafa574ea11d54f61b2fd8d291e36154e5f5efe /tox.ini | |
parent | fbec8835ec57be01834b7b5ec4283346ab54bc12 (diff) |
OVN4NFV Local Documentation Builds
This adds configuration for performing local documentation builds with
the following simple command:
tox -e docs
Change-Id: I757809ddd5f9b33fbcb1df295eaad41eaf28b8cd
Signed-off-by: Trevor Bramwell <tbramwell@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 |