From 05ddd9fc9e814b8a949ee65b512b35f2432ccec6 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Tue, 2 Apr 2019 14:39:50 +0100 Subject: docs: Use sphinxcontrib.apidoc for building API docs Gets us away from the old pbr functionality. Some cleanup of tox.ini is included along the way. Change-Id: Ia228f8ee49f31f88fa2a66f2aad3a3921c41a785 --- tox.ini | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) (limited to 'tox.ini') diff --git a/tox.ini b/tox.ini index bb733d5..f4054e5 100644 --- a/tox.ini +++ b/tox.ini @@ -1,34 +1,29 @@ [tox] minversion = 2.0 -envlist = py35,py27,pep8 +envlist = py27,py35,pep8 [testenv] -install_command = pip install {opts} {packages} -whitelist_externals = bash - env +whitelist_externals = + env +passenv = + OS_TEST_DBAPI_ADMIN_CONNECTION setenv = - VIRTUAL_ENV={envdir} - BASECOMMAND=stestr run - BRANCH_NAME=master - CLIENT_NAME=oslo.db - - {postgresql,all}: PIFPAF_POSTGRESQL=pifpaf -g OS_TEST_DBAPI_ADMIN_CONNECTION run postgresql -- - {mysql,all}: PIFPAF_MYSQL=pifpaf -g OS_TEST_DBAPI_ADMIN_CONNECTION run mysql -- - {mysql,postgresql,all}: BASECOMMAND={toxinidir}/tools/run-pifpaf-tests.sh + BASECOMMAND=stestr run + {postgresql,all}: PIFPAF_POSTGRESQL=pifpaf -g OS_TEST_DBAPI_ADMIN_CONNECTION run postgresql -- + {mysql,all}: PIFPAF_MYSQL=pifpaf -g OS_TEST_DBAPI_ADMIN_CONNECTION run mysql -- + {mysql,postgresql,all}: BASECOMMAND={toxinidir}/tools/run-pifpaf-tests.sh deps = - -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt} - -r{toxinidir}/test-requirements.txt - -r{toxinidir}/requirements.txt + -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt} + -r{toxinidir}/test-requirements.txt + -r{toxinidir}/requirements.txt commands = {env:PIFPAF_MYSQL:} {env:PIFPAF_POSTGRESQL:} {env:BASECOMMAND:} {posargs} -passenv = OS_TEST_DBAPI_ADMIN_CONNECTION - [testenv:py27] basepython = python2.7 commands = - env TEST_EVENTLET=0 stestr run {posargs} - env TEST_EVENTLET=1 stestr run {posargs} + env TEST_EVENTLET=0 stestr run {posargs} + env TEST_EVENTLET=1 stestr run {posargs} [testenv:pep8] basepython = python3 @@ -44,19 +39,24 @@ commands = {posargs} [testenv:cover] basepython = python3 setenv = - PYTHON=coverage run --source oslo_db --parallel-mode + PYTHON=coverage run --source oslo_db --parallel-mode commands = - stestr run {posargs} - coverage combine - coverage html -d cover - coverage xml -o cover/coverage.xml + stestr run {posargs} + coverage combine + coverage html -d cover + coverage xml -o cover/coverage.xml [testenv:docs] basepython = python3 -deps = -r{toxinidir}/doc/requirements.txt +whitelist_externals = + rm +deps = + {[testenv]deps} + -r{toxinidir}/doc/requirements.txt commands = - doc8 -e .rst CONTRIBUTING.rst HACKING.rst README.rst doc/source - sphinx-build -b html doc/source doc/build/html + rm -rf doc/build doc/source/reference/api + doc8 -e .rst CONTRIBUTING.rst HACKING.rst README.rst doc/source + sphinx-build -W -b html doc/source doc/build/html [testenv:releasenotes] basepython = python3 -- cgit v1.2.1