From eec6024f101e50cbfeed7cbb4a5a0be7c752a00f Mon Sep 17 00:00:00 2001 From: Nguyen Hai Date: Wed, 21 Mar 2018 01:08:28 +0900 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 http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: Id830b5206728b102e9da2ede6e894a6375e02e75 --- doc/requirements.txt | 6 ++++++ setup.cfg | 10 ---------- test-requirements.txt | 3 --- tox.ini | 10 +++++++++- 4 files changed, 15 insertions(+), 14 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 000000000..a5c5dcb9f --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +# 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. +openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +reno>=2.5.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index 87b56e534..129f06639 100644 --- a/setup.cfg +++ b/setup.cfg @@ -35,16 +35,6 @@ console_scripts = oslo.config.opts = manilaclient.config = manilaclient.config:list_opts -[build_sphinx] -builders = html,man -all-files = 1 -warning-is-error = 1 -source-dir = doc/source -build-dir = doc/build - -[upload_sphinx] -upload-dir = doc/build/html - [wheel] universal = 1 diff --git a/test-requirements.txt b/test-requirements.txt index a68d1d315..e3166394d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,11 +9,8 @@ coverage!=4.4,>=4.0 # Apache-2.0 ddt>=1.0.1 # MIT fixtures>=3.0.0 # Apache-2.0/BSD mock>=2.0.0 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD tempest>=17.1.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=2.2.0 # MIT python-openstackclient>=3.12.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 532acd1dd..5cf7cffdb 100644 --- a/tox.ini +++ b/tox.ini @@ -40,12 +40,20 @@ commands = {posargs} [testenv:docs] basepython = python2.7 +deps = + -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} + -r{toxinidir}/requirements.txt + -r{toxinidir}/doc/requirements.txt whitelist_externals = rm commands = rm -rf doc/build - python setup.py build_sphinx + sphinx-build -b html doc/source doc/build/html [testenv:releasenotes] +deps = + -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} + -r{toxinidir}/requirements.txt + -r{toxinidir}/doc/requirements.txt whitelist_externals = rm commands = rm -rf releasenotes/build