diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 12:10:43 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2018-10-02 13:56:37 -0400 |
| commit | 9666d8bb3df726d88d08d5811d2a99e713908396 (patch) | |
| tree | 2d6610abee50cdd3b0bd2a3c2159e6e257904e9d /tox.ini | |
| parent | 82bf9da27ea0c973068720d440e3391084e8a9d9 (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>
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 |