From a60daf4f601c2b24f70d327d33c693af0aca02ec Mon Sep 17 00:00:00 2001 From: junboli Date: Wed, 17 Jan 2018 09:43:25 +0800 Subject: [PATCH] Follow the new PTI for document build For compliance with the Project Testing Interface as described in [1]: [1] https://governance.openstack.org/tc/reference/project-testing-interface.html For more detials information, please refer to [2]: [2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: I1fe5352e8e4a7703bd9908e7221f04110163d6fb --- doc/requirements.txt | 12 ++++++++++++ test-requirements.txt | 4 ---- tox.ini | 14 +++++++++++--- 3 files changed, 23 insertions(+), 7 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000000..f465e13c17 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,12 @@ +# 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.17.0 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 +doc8>=0.6.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +mock>=2.0.0 # BSD +os-api-ref>=1.4.0 # Apache-2.0 +ddt>=1.0.1 # MIT +fixtures>=3.0.0 # Apache-2.0/BSD +oslotest>=3.2.0 # Apache-2.0 \ No newline at end of file diff --git a/test-requirements.txt b/test-requirements.txt index 5e6cedfc82..cc4859d0ee 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -12,7 +12,6 @@ fixtures>=3.0.0 # Apache-2.0/BSD mock>=2.0.0 # BSD iso8601>=0.1.11 # MIT oslotest>=3.2.0 # Apache-2.0 -openstackdocstheme>=1.17.0 # Apache-2.0 # Do not remove 'PyMySQL' and 'psycopg2' dependencies. They are used # by oslo_db lib for running MySQL and PostgreSQL DB migration tests. @@ -21,11 +20,8 @@ PyMySQL>=0.7.6 # MIT License psycopg2>=2.6.2 # LGPL/ZPL requests-mock>=1.1.0 # Apache-2.0 -sphinx>=1.6.2 # BSD os-api-ref>=1.4.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 testresources>=2.0.0 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT -reno>=2.5.0 # Apache-2.0 -doc8>=0.6.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 904aef10eb..95d2259f6f 100644 --- a/tox.ini +++ b/tox.ini @@ -15,11 +15,15 @@ commands = ostestr {posargs} [testenv:releasenotes] -whitelist_externals = rm +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 commands = rm -rf releasenotes/build sphinx-build -a -E -W -d releasenotes/build/doctrees \ -b html releasenotes/source releasenotes/build/html +whitelist_externals = rm [testenv:debug] commands = oslo_debug_helper {posargs} @@ -64,12 +68,16 @@ commands = oslopolicy-sample-generator --config-file=etc/manila/manila-policy-ge commands = {posargs} [testenv:docs] -whitelist_externals = rm +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 commands = rm -rf doc/build - python setup.py build_sphinx + sphinx-build -b html doc/source doc/build/html # Ignore D001 since we allow lines in excess of 79 characters. doc8 --ignore D001 --ignore-path .tox --ignore-path doc/build --ignore-path manila.egg-info -e txt -e rst +whitelist_externals = rm [testenv:cover] setenv =