From fdab5025262f6f13fac8bfe8f0f2c0d3ad387927 Mon Sep 17 00:00:00 2001 From: Jesse Pretorius Date: Mon, 2 Jul 2018 08:05:33 +0100 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 details information, please refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html In order to pass the requirements check, a new lower bound is set for the 'pyasn1' and 'requests' packages. Change-Id: Ia136d992b96c92f80a6b07448a48855ed324fb9d --- doc/requirements.txt | 10 ++++++++++ test-requirements.txt | 12 ++---------- tox.ini | 5 ++++- 3 files changed, 16 insertions(+), 11 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..b3abbc3 --- /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.7,>=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 1d5d858..2ad54bf 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,15 +3,7 @@ # process, which may cause wedges in the gate later. bashate>=0.2 # Apache-2.0 flake8<2.6.0,>=2.5.4 # MIT -pyasn1 # BSD +pyasn1>=0.1.8 # BSD pyOpenSSL>=0.14 # Apache-2.0 -requests!=2.12.2,!=2.13.0,>=2.10.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.1,>=1.5.1 # BSD -oslosphinx>=4.7.0 # Apache-2.0 -openstackdocstheme>=1.5.0 # Apache-2.0 -doc8 # Apache-2.0 -reno>=1.8.0 # Apache-2.0 -sphinxmark>=0.1.14 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 7ede620..f3f348e 100644 --- a/tox.ini +++ b/tox.ini @@ -31,10 +31,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] @@ -43,6 +44,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 @@ -99,6 +101,7 @@ commands = [testenv:linters] deps = + -r{toxinidir}/doc/requirements.txt {[testenv:ansible]deps} commands = {[testenv:pep8]commands}