From 540408f59753cfe4b341d101e489fc30ad93216a Mon Sep 17 00:00:00 2001 From: melissaml Date: Mon, 12 Mar 2018 11:32: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: I56c7a5247235f550ee3ed4344f79c8fa9e86cc67 --- 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 00000000..21d6c33b --- /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.2 # BSD +openstackdocstheme>=1.18.1 # Apache-2.0 +doc8>=0.6.0 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 +Jinja2>=2.10 # BSD License (3 clause) +lxml!=3.7.0,>=3.4.1 # BSD diff --git a/test-requirements.txt b/test-requirements.txt index 8870e038..2d59dc94 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,11 +7,3 @@ pyasn1!=0.2.3,>=0.1.8 # BSD pyOpenSSL>=16.2.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.2 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 -doc8>=0.6.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 -Jinja2>=2.10 # BSD License (3 clause) -lxml!=3.7.0,>=3.4.1 # BSD diff --git a/tox.ini b/tox.ini index 266a5b1e..eb9a4d57 100644 --- a/tox.ini +++ b/tox.ini @@ -32,12 +32,13 @@ setenv = [testenv:docs] +deps = -r{toxinidir}/doc/requirements.txt commands= bash -c "rm -rf doc/build" # NOTE(mhayden): doc8 really dislikes the automated docs. This should be # enabled again later. #doc8 doc - python setup.py build_sphinx + sphinx-build -W -b html doc/source doc/build/html [doc8] @@ -47,6 +48,7 @@ allow-long-titles=1 [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 @@ -118,4 +120,3 @@ commands = {[testenv:bashate]commands} {[testenv:ansible-lint]commands} {[testenv:ansible-syntax]commands} - {[testenv:docs]commands}