From 80bee99f277bd981cd32053d5e6586361f224bd3 Mon Sep 17 00:00:00 2001 From: melissaml Date: Wed, 21 Mar 2018 03:26:19 +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: I12655940f683caec7cc0708a42ddf52720de6dbe --- doc/requirements.txt | 11 +++++++++++ test-requirements.txt | 8 -------- tox.ini | 5 +++-- 3 files changed, 14 insertions(+), 10 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..2cba12a --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,11 @@ +# 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.7,>=1.6.2 # BSD +oslosphinx>=4.7.0 # Apache-2.0 +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/test-requirements.txt b/test-requirements.txt index fac6795..82506c5 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,11 +7,3 @@ pyasn1!=0.2.3,>=0.1.8 # BSD pyOpenSSL>=17.1.0 # Apache-2.0 requests>=2.14.2 # Apache-2.0 ndg-httpsclient>=0.4.2;python_version<'3.0' # BSD - -# this is required for the docs build jobs -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 -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 9b3220d..703bf63 100644 --- a/tox.ini +++ b/tox.ini @@ -32,10 +32,11 @@ 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 [doc8] @@ -44,6 +45,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 @@ -112,4 +114,3 @@ commands = {[testenv:bashate]commands} {[testenv:ansible-lint]commands} {[testenv:ansible-syntax]commands} - {[testenv:docs]commands}