From 17aedacea5aff94232c03ccedb5e0ff569849a3a Mon Sep 17 00:00:00 2001 From: Nguyen Hai Date: Wed, 30 May 2018 15:02:54 +0900 Subject: [PATCH] Follow the new PTI for document build Reference: https://governance.openstack.org/tc/reference/project-testing-interface.html http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: I32256af5d8530435321e84f5dd19d8a9ce57840a --- doc/requirements.txt | 5 +++++ setup.cfg | 10 +--------- test-requirements.txt | 2 -- tox.ini | 3 ++- 4 files changed, 8 insertions(+), 12 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..88712382 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,5 @@ +# 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. +openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD diff --git a/setup.cfg b/setup.cfg index 21d0c6f1..c0eed591 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ description-file = README.rst author = OpenStack author-email = openstack-dev@lists.openstack.org -home-page = http://docs.openstack.org/developer/heat-translator/ +home-page = http://docs.openstack.org/heat-translator/ classifier = Environment :: OpenStack Intended Audience :: Information Technology @@ -35,14 +35,6 @@ openstack.translator.v1 = console_scripts = heat-translator = translator.shell:main -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [compile_catalog] directory = translator/locale domain = translator diff --git a/test-requirements.txt b/test-requirements.txt index e46ebf28..8f582893 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,9 +5,7 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD oslotest>=3.2.0 # Apache-2.0 -openstackdocstheme>=1.18.1 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT diff --git a/tox.ini b/tox.ini index c92bf496..49fc41b3 100644 --- a/tox.ini +++ b/tox.ini @@ -26,7 +26,8 @@ commands = {posargs} commands = python setup.py test --coverage --coverage-package-name=translator --testr-args='{posargs}' [testenv:docs] -commands = python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -b html doc/source doc/build/html [testenv:debug] commands = oslo_debug_helper -t translator/tests {posargs}