summaryrefslogtreecommitdiffstats
path: root/tox.ini
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-09-18 12:59:30 -0400
committerAric Gardner <agardner@linuxfoundation.org>2018-10-25 12:08:48 -0400
commit4e54b544e3b2bc4e06631a24659a28f15d9b2490 (patch)
tree8ea973f056560413a45d0e32a007512345f1434c /tox.ini
parent59db88a0554459514e40fd512e3d105820a9086f (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 effort to Move away from submodules https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html Once merged docs will be viewable at opnfv-nfvbench.readthedocs.io Change-Id: I7c877847ec23c4cfc44ff7f106ed2acc65688a41 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'tox.ini')
-rw-r--r--tox.ini16
1 files changed, 12 insertions, 4 deletions
diff --git a/tox.ini b/tox.ini
index 354740f..337ee0d 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,6 +1,6 @@
[tox]
minversion = 1.6
-envlist = py27,pep8, lint
+envlist = py27,pep8,lint,docs,docs-linkcheck
skipsdist = True
[testenv]
@@ -24,9 +24,6 @@ commands = {posargs}
[testenv:cover]
commands = python setup.py testr --coverage --testr-args='{posargs}'
-[testenv:docs]
-commands = python setup.py build_sphinx
-
[flake8]
# H803 skipped on purpose per list discussion.
# E123, E125 skipped as they are invalid PEP-8.
@@ -43,3 +40,14 @@ show-source = True
ignore = E123,E125,H803,E302,E303,H104,H233,H236,H302,H404,H405,H904,D102,D100,D107
builtins = _
exclude=venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build,dib-venv
+
+[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