From 7adecf3d030f97ee1d19dcbda3272f88b71dd5d1 Mon Sep 17 00:00:00 2001 From: Georg Kunz Date: Wed, 2 May 2018 23:54:35 +0200 Subject: Adding a tox environment for locally building docs Run tox -edocs to locally build the Dovetail docs. This is quite useful because the default OPNFV docs preview build toolchain is broken for Dovetail. Change-Id: I0a55a701b96437a20aa09edc47bc3e49e32c0b87 Signed-off-by: Georg Kunz --- tox.ini | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'tox.ini') diff --git a/tox.ini b/tox.ini index 5237e95f..9b94ee72 100644 --- a/tox.ini +++ b/tox.ini @@ -15,6 +15,9 @@ setenv = VIRTUAL_ENV={envdir} HOME = {envtmpdir} PYTHONPATH = {toxinidir} +whitelist_externals = wget + touch + echo [testenv:pep8] deps = flake8 @@ -29,3 +32,12 @@ commands = python setup.py testr --coverage \ show-source = True ignore = E123,E125,H803,E722 exclude = .tox,dist,docs,*egg,build,.venv,.git + +[testenv:docs] +commands = + touch ./docs/index.rst + - wget -q -nc https://raw.githubusercontent.com/opnfv/opnfvdocs/master/etc/requirements.txt -O ./docs/requirements.txt + pip install -r ./docs/requirements.txt + pip install sphinx_opnfv_theme + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" -- cgit 1.2.3-korg