From c9eb1441fbdd38f2bf857430d8d3f572d1fd43dd Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Fri, 9 Mar 2018 10:01:57 +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: I97c08f18e60b75308099228d08ffd9436cc5b6e2 --- doc/requirements.txt | 10 ++++++++++ test-requirements.txt | 7 ------- tox.ini | 6 ++++-- 3 files changed, 14 insertions(+), 9 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000000..7e68e1c730 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,10 @@ +# 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. + +# this is required for the docs build jobs +sphinx!=1.6.6,>=1.6.2 # BSD +openstackdocstheme>=1.18.1 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 +sphinxmark>=0.1.14 # Apache-2.0 +doc8>=0.6.0 # Apache-2.0 diff --git a/test-requirements.txt b/test-requirements.txt index 3b4da26299..20122f76dc 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -8,10 +8,3 @@ bashate>=0.5.1 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 mock>=2.0.0 # BSD virtualenv>=14.0.6 # MIT - -# this is required for the docs build jobs -sphinx!=1.6.6,>=1.6.2 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 -doc8>=0.6.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 -sphinxmark>=0.1.14 # Apache-2.0 diff --git a/tox.ini b/tox.ini index b1ef8e28c9..429495e456 100644 --- a/tox.ini +++ b/tox.ini @@ -35,14 +35,16 @@ setenv = [testenv:docs] +deps = -r{toxinidir}/doc/requirements.txt commands= bash -c "rm -rf doc/build" doc8 doc - python setup.py build_sphinx + sphinx-build -b html doc/source doc/build/html [testenv:deploy-guide] +deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -a -E -W -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html @@ -54,6 +56,7 @@ extensions = .rst [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 @@ -157,4 +160,3 @@ commands = {[testenv:ansible-lint]commands} {[testenv:ansible-syntax]commands} {[testenv:inventory]commands} - {[testenv:docs]commands}