From 794dea38175944cbf52d9042db0d1a47d862a0ba Mon Sep 17 00:00:00 2001 From: melissaml Date: Tue, 27 Mar 2018 10:30:27 +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: Ic7dad29922af2efed2188f3215f364719f0e19ae --- doc/requirements.txt | 6 ++++++ setup.cfg | 6 ------ test-requirements.txt | 6 ------ tox.ini | 12 +++++++++--- 4 files changed, 15 insertions(+), 15 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 000000000..86fc0cb55 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +sphinxcontrib-httpdomain>=1.3.0 # BSD +sphinxcontrib-blockdiag>=1.5.4 # BSD +reno>=2.5.0 # Apache-2.0 +os-api-ref>=1.4.0 # Apache-2.0 +openstackdocstheme>=1.18.1 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index ace7694fe..1aa8d66b4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -143,12 +143,6 @@ designate.notification.plugin = default = designate.notifications:Default audit = designate.notifications:Audit -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source -warning-is-error = 1 - [egg_info] tag_build = tag_date = 0 diff --git a/test-requirements.txt b/test-requirements.txt index 8274d57eb..851ff4a42 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,18 +10,12 @@ mock>=2.0.0 # BSD os-testr>=1.0.0 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 requests-mock>=1.2.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD -sphinxcontrib-httpdomain>=1.3.0 # BSD testtools>=2.2.0 # MIT -sphinxcontrib-blockdiag>=1.5.4 # BSD testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD WebTest>=2.0.27 # MIT tempest>=17.1.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 # Bandit security code scanner bandit>=1.1.0 # Apache-2.0 -os-api-ref>=1.4.0 # Apache-2.0 zake>=0.1.6 # Apache-2.0 -openstackdocstheme>=1.18.1 # Apache-2.0 doc8>=0.6.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 7d549de73..ec0f4aba6 100644 --- a/tox.ini +++ b/tox.ini @@ -38,9 +38,11 @@ commands = ostestr '{posargs}' [testenv:docs] -basepython = python2.7 -commands = rm -rf doc/build - python setup.py build_sphinx +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 -W -b html doc/source doc/build/html [testenv:cover] commands = @@ -115,6 +117,10 @@ commands = sphinx-build -E -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 -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html [testenv:venv]