diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 12:10:43 -0400 |
|---|---|---|
| committer |   Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-10-03 18:41:40 +0000 |
| commit | cfcabcdc552514702740f5f69c62b5e799b9f24b (patch) | |
| tree | dd15a41180627372e643cae3ad4623a3f2cd7363 /tox.ini | |
| parent | 4c064f249a723b0e4a2a0411dcb8cc306e05dff1 (diff) | |
Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
This patch is part of our documentation effor to Move away from submodules
https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html
added index.rst so that docs build succsesfully
Change-Id: I2d28f03ad4d5c9c14de095dc544257af9d1e51d9
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
(cherry picked from commit 9666d8bb3df726d88d08d5811d2a99e713908396)
Diffstat (limited to 'tox.ini')
| -rw-r--r-- | tox.ini | 12 |
1 files changed, 11 insertions, 1 deletions
@@ -1,5 +1,5 @@ [tox] -envlist = docs,pep8,pylint,py35 +envlist = docs,docs-linkcheck,pep8,pylint,py35 [testenv] usedevelop = True @@ -24,3 +24,13 @@ commands = flake8 --exclude .build,build --ignore=F401 [testenv:py35] basepython = python3 +[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 |