From 2ba0aa94a0024332b119e49274bcd027225141e5 Mon Sep 17 00:00:00 2001 From: "ChangBo Guo(gcb)" Date: Tue, 19 Dec 2017 13:41:54 +0800 Subject: [PATCH] Follow the new PTI for document build For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html For more detials information, please refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: I3d86f1897dc900ba815c0c3975e95e27bb29b532 --- doc/requirements.txt | 5 +++++ test-requirements.txt | 6 ------ tox.ini | 4 +++- 3 files changed, 8 insertions(+), 7 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..26ef9b95 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,5 @@ +# this is required for the docs build jobs +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.17.0 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 +fixtures>=3.0.0 # Apache-2.0/BSD diff --git a/test-requirements.txt b/test-requirements.txt index c0720874..293b7e8d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -17,10 +17,6 @@ ddt>=1.0.1 # MIT # deps = {[testenv]deps} coverage coverage!=4.4,>=4.0 # Apache-2.0 -# this is required for the docs build jobs -sphinx>=1.6.2 # BSD -openstackdocstheme>=1.17.0 # Apache-2.0 - # mocking framework mock>=2.0.0 # BSD @@ -29,5 +25,3 @@ oslo.config>=5.1.0 # Apache-2.0 # Bandit security code scanner bandit>=1.1.0 # Apache-2.0 - -reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 5044eb11..ed1dd2c1 100644 --- a/tox.ini +++ b/tox.ini @@ -20,7 +20,8 @@ commands = commands = {posargs} [testenv:docs] -commands = python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -b html doc/source doc/build/html [testenv:cover] commands = python setup.py test --coverage --coverage-package-name=oslo_utils --testr-args='{posargs}' @@ -42,4 +43,5 @@ deps = pip_missing_reqs commands = pip-missing-reqs -d --ignore-module=oslo_utils* --ignore-module=pkg_resources --ignore-file=oslo_utils/test.py --ignore-file=oslo_utils/tests/* oslo_utils [testenv:releasenotes] +deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html