From 4f81c419947e2793e3eda4ce8f3664058b5a5d2c Mon Sep 17 00:00:00 2001 From: "ChangBo Guo(gcb)" Date: Tue, 19 Dec 2017 13:21:37 +0800 Subject: [PATCH] Use 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 detials information, please refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: Iba311cc69ec5272d8beb433e3589c53f371d5d0a --- doc/requirements.txt | 8 ++++++++ setup.cfg | 4 ---- tox.ini | 4 +++- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index dd46184e..3882b4d3 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,3 +3,11 @@ # process, which may cause wedges in the gate later. openstackdocstheme>=1.17.0 # Apache-2.0 sphinx>=1.6.2 # BSD +doc8>=0.6.0 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 + +# These modules are needed when generating document +fixtures>=3.0.0 # Apache-2.0/BSD +testresources>=2.0.0 # Apache-2.0/BSD +testscenarios>=0.4 # Apache-2.0/BSD +oslotest>=1.10.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index c2c5219d..9da68932 100644 --- a/setup.cfg +++ b/setup.cfg @@ -29,19 +29,15 @@ postgresql = test = hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 - doc8>=0.6.0 # Apache-2.0 eventlet!=0.18.3,!=0.20.1,<0.21.0,>=0.18.2 # MIT fixtures>=3.0.0 # Apache-2.0/BSD mock>=2.0.0 # BSD python-subunit>=1.0.0 # Apache-2.0/BSD - sphinx>=1.6.2 # BSD - openstackdocstheme>=1.17.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 oslo.context>=2.19.2 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=2.2.0 # MIT os-testr>=1.0.0 # Apache-2.0 - reno>=2.5.0 # Apache-2.0 fixtures = testresources>=2.0.0 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD diff --git a/tox.ini b/tox.ini index 7df46f52..6aad1b72 100644 --- a/tox.ini +++ b/tox.ini @@ -43,11 +43,13 @@ commands = {posargs} commands = python setup.py test --coverage --coverage-package-name=oslo_db --testr-args='{posargs}' [testenv:docs] +deps = -r{toxinidir}/doc/requirements.txt commands = doc8 -e .rst CONTRIBUTING.rst HACKING.rst README.rst doc/source - python setup.py build_sphinx + sphinx-build -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 [flake8]