From f877ec291776930737c509220a7ac4a74cc2ed15 Mon Sep 17 00:00:00 2001 From: jiansong Date: Tue, 19 Dec 2017 01:25:36 -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: I84e614346cfa4d302f919d12bea9680c5e527475 --- doc/requirements.txt | 8 ++++++++ test-requirements.txt | 4 ---- tox.ini | 10 +++++++++- 3 files changed, 17 insertions(+), 5 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000000..3c6f7fbbcca --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,8 @@ +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 diff --git a/test-requirements.txt b/test-requirements.txt index 92eb8395b2a..eaf3d838a67 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -11,17 +11,13 @@ fixtures>=3.0.0 # Apache-2.0/BSD mock>=2.0.0 # BSD os-api-ref>=1.4.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 -sphinx>=1.6.2 # BSD PyMySQL>=0.7.6 # MIT License psycopg2>=2.6.2 # LGPL/ZPL python-subunit>=1.0.0 # Apache-2.0/BSD testtools>=2.2.0 # MIT testresources>=2.0.0 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD -openstackdocstheme>=1.17.0 # Apache-2.0 oslo.versionedobjects[fixtures]>=1.28.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 tempest>=17.1.0 # Apache-2.0 bandit>=1.1.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 -doc8>=0.6.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index ab89fb5c0a6..b09375e063a 100644 --- a/tox.ini +++ b/tox.ini @@ -42,6 +42,10 @@ commands = sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/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 commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html [testenv:functional] @@ -105,9 +109,13 @@ commands = python tools/config/generate_cinder_opts.py commands = {posargs} [testenv:docs] +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 -fr doc/build doc/source/contributor/api/ .autogenerated - python setup.py build_sphinx + sphinx-build -b html doc/source doc/build/html rm -rf api-ref/build sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html/ doc8 --ignore D001 --ignore-path .tox --ignore-path *.egg-info --ignore-path doc/src/api --ignore-path doc/source/drivers.rst --ignore-path doc/build --ignore-path .eggs/*/EGG-INFO/*.txt -e txt -e rst