From f277b8770300e6a0446302528ddcfffeb9d48c0f Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Fri, 2 Mar 2018 09:49:11 +0800 Subject: 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: I35fb490d34af834182522a856d6ab7e24d0ec678 --- doc/requirements.txt | 8 ++++++++ test-requirements.txt | 3 --- tox.ini | 4 +++- 3 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..acb43cd --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,8 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +# These are needed for docs generation +openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx!=1.6.6,>=1.6.2 # BSD +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 9067d92..5e89e88 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,12 +5,9 @@ fixtures>=3.0.0 # Apache-2.0/BSD hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 mock>=2.0.0 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 -sphinx!=1.6.6,>=1.6.2 # BSD testtools>=2.2.0 # MIT coverage!=4.4,>=4.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 oslo.serialization!=2.19.1,>=2.18.0 # Apache-2.0 # Bandit security code scanner bandit>=1.1.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 6f3dec8..5d4d7c7 100644 --- a/tox.ini +++ b/tox.ini @@ -21,7 +21,8 @@ commands = commands = {posargs} [testenv:docs] -commands = python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -W -b html doc/source doc/build/html [testenv:cover] commands = python setup.py test --coverage --coverage-package-name=oslo_middleware --testr-args='{posargs}' @@ -45,4 +46,5 @@ deps = pip_missing_reqs commands = pip-missing-reqs -d --ignore-module=oslo_middleware* --ignore-module=pkg_resources --ignore-file=oslo_middleware/tests/* oslo_middleware [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 -- cgit v1.2.1