From 47f8ffdcefa9ff1d878b129905778d4c04ae311f Mon Sep 17 00:00:00 2001 From: melissaml Date: Wed, 21 Mar 2018 04:09:32 +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 http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: Ib988f55336b2531f66b899e6426097317681757e --- doc/requirements.txt | 3 +++ setup.cfg | 8 -------- test-requirements.txt | 5 ----- tox.ini | 4 +++- 4 files changed, 6 insertions(+), 14 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..7eba426 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,3 @@ +sphinx>=1.6.2 # BSD +oslosphinx>=4.7.0 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index 2ad62e3..5246d33 100644 --- a/setup.cfg +++ b/setup.cfg @@ -33,14 +33,6 @@ openstack.valence.v1 = valence_podmanager_delete = valenceclient.osc.v1.podmanager:DeletePodManagers valence_podmanager_show = valenceclient.osc.v1.podmanager:ShowPodManager -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [compile_catalog] directory = valenceclient/locale domain = valenceclient diff --git a/test-requirements.txt b/test-requirements.txt index e9d2503..c4111c1 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,8 +6,6 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD -sphinx>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD @@ -16,6 +14,3 @@ oslo.utils>=3.33.0 # Apache-2.0 oslo.i18n>=3.15.3 # Apache-2.0 oslo.serialization!=2.19.1,>=2.18.0 # Apache-2.0 requests-mock>=1.1.0 # Apache-2.0 - -# releasenotes -reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index c888992..a041eb1 100644 --- a/tox.ini +++ b/tox.ini @@ -22,9 +22,11 @@ commands = {posargs} commands = python setup.py test --coverage --testr-args='{posargs}' [testenv:docs] -commands = python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -W -b html doc/source doc/build/html [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