From 0556a2ab737dfa1464062266a3154a30f40f0f85 Mon Sep 17 00:00:00 2001 From: Nguyen Hai Date: Thu, 22 Mar 2018 17:09:45 +0900 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 http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Remove the '[build_sphinx]' as described in: http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: Id3d7065028b4c0831e6b5c2363b19626734817a3 --- doc/requirements.txt | 6 ++++++ setup.cfg | 5 ----- test-requirements.txt | 4 ---- tox.ini | 3 +++ 4 files changed, 9 insertions(+), 9 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000000..fa203897839 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +# 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. +sphinx!=1.6.6,>=1.6.2 # BSD +openstackdocstheme>=1.18.1 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index f8d7b998666..9b45661deed 100644 --- a/setup.cfg +++ b/setup.cfg @@ -153,11 +153,6 @@ neutron.services.metering_drivers = noop = neutron.services.metering.drivers.noop.noop_driver:NoopMeteringDriver iptables = neutron.services.metering.iptables.iptables_driver:IptablesMeteringDriver -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source -warning-is-error = 1 [extract_messages] keywords = _ gettext ngettext l_ lazy_gettext diff --git a/test-requirements.txt b/test-requirements.txt index 5b087c9d451..4fe136dddd5 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,9 +9,6 @@ fixtures>=3.0.0 # Apache-2.0/BSD flake8-import-order==0.12 # LGPLv3 mock>=2.0.0 # BSD python-subunit>=1.0.0 # Apache-2.0/BSD -sphinx!=1.6.6,>=1.6.2 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 -oslosphinx>=4.7.0 # Apache-2.0 testtools>=2.2.0 # MIT testresources>=2.0.0 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD @@ -20,7 +17,6 @@ oslotest>=3.2.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 ddt>=1.0.1 # MIT pylint==1.4.5 # GPLv2 -reno>=2.5.0 # Apache-2.0 # Needed to run DB commands in virtualenvs PyMySQL>=0.7.6 # MIT License bashate>=0.5.1 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 53a28417273..508750c911c 100644 --- a/tox.ini +++ b/tox.ini @@ -93,6 +93,7 @@ commands = [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 [testenv:pep8] @@ -125,9 +126,11 @@ commands = commands = {posargs} [testenv:docs] +deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -W -b html doc/source doc/build/html [testenv:linkcheck] +deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -W -b linkcheck doc/source doc/build/linkcheck [flake8]