From f81f379cfafb8f18a5ccd7300256e3fdbca1417c Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Tue, 18 Sep 2018 12:18:45 -0400 Subject: 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 Your project is now required to have a docs/index.rst so if you are missing this file please create it. Change-Id: I32a91a4194e4afe98f4c964052e99419b22330ba Signed-off-by: Aric Gardner (cherry picked from commit 42333625db781f1ae12212ce903df9b5257ff5e4) --- tox.ini | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'tox.ini') diff --git a/tox.ini b/tox.ini index 832a1dae..8a5df05e 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 2.3.1 -envlist = py34, pep8 +envlist = py34, pep8,docs,docs-linkcheck skipsdist = True [testenv] @@ -49,3 +49,14 @@ enable-extensions=H106,H203 builtins = _ filename = *.py,app.wsgi exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tests + +[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 -- cgit 1.2.3-korg