From 72e3217e5e48389aefed6968e9c30af8916dc357 Mon Sep 17 00:00:00 2001 From: Nguyen Van Trung Date: Mon, 9 Jul 2018 13:49:06 +0700 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 Change-Id: Ia8a5a4eb2770976ac7b3b99c6d32d8aa37cedac7 --- doc/requirements.txt | 3 +++ setup.cfg | 9 --------- test-requirements.txt | 3 --- tox.ini | 3 ++- 4 files changed, 5 insertions(+), 13 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..c28b5b26 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,3 @@ +openstackdocstheme>=1.18.1 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 +sphinx!=1.6.6,>=1.6.2 # BSD diff --git a/setup.cfg b/setup.cfg index 2832ca63..6b4b1ffc 100644 --- a/setup.cfg +++ b/setup.cfg @@ -31,15 +31,6 @@ packages = data_files = libexec/kuryr = usr/libexec/kuryr/* -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 -warning-is-error = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [compile_catalog] directory = kuryr/locale domain = kuryr diff --git a/test-requirements.txt b/test-requirements.txt index 279289d2..e0162f0f 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,11 +7,8 @@ coverage!=4.4,>=4.0 # Apache-2.0 ddt>=1.0.1 # MIT hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 -openstackdocstheme>=1.18.1 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD -reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,>=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 4b9f446f..4c99fe35 100644 --- a/tox.ini +++ b/tox.ini @@ -54,7 +54,8 @@ commands = [testenv:docs] basepython = python3 -commands = python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html [flake8] # E125 continuation line does not distinguish itself from next logical line