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: Id830b5206728b102e9da2ede6e894a6375e02e75
This commit is contained in:
Nguyen Hai 2018-03-21 01:08:28 +09:00
parent f4090b1868
commit eec6024f10
4 changed files with 15 additions and 14 deletions

6
doc/requirements.txt Normal file
View File

@ -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.
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
reno>=2.5.0 # Apache-2.0

View File

@ -35,16 +35,6 @@ console_scripts =
oslo.config.opts = oslo.config.opts =
manilaclient.config = manilaclient.config:list_opts manilaclient.config = manilaclient.config:list_opts
[build_sphinx]
builders = html,man
all-files = 1
warning-is-error = 1
source-dir = doc/source
build-dir = doc/build
[upload_sphinx]
upload-dir = doc/build/html
[wheel] [wheel]
universal = 1 universal = 1

View File

@ -9,11 +9,8 @@ coverage!=4.4,>=4.0 # Apache-2.0
ddt>=1.0.1 # MIT ddt>=1.0.1 # MIT
fixtures>=3.0.0 # Apache-2.0/BSD fixtures>=3.0.0 # Apache-2.0/BSD
mock>=2.0.0 # BSD mock>=2.0.0 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
os-testr>=1.0.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
tempest>=17.1.0 # Apache-2.0 tempest>=17.1.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD testrepository>=0.0.18 # Apache-2.0/BSD
testtools>=2.2.0 # MIT testtools>=2.2.0 # MIT
python-openstackclient>=3.12.0 # Apache-2.0 python-openstackclient>=3.12.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0

10
tox.ini
View File

@ -40,12 +40,20 @@ commands = {posargs}
[testenv:docs] [testenv:docs]
basepython = python2.7 basepython = python2.7
deps =
-c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
-r{toxinidir}/requirements.txt
-r{toxinidir}/doc/requirements.txt
whitelist_externals = rm whitelist_externals = rm
commands = commands =
rm -rf doc/build rm -rf doc/build
python setup.py build_sphinx sphinx-build -b html doc/source doc/build/html
[testenv:releasenotes] [testenv:releasenotes]
deps =
-c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
-r{toxinidir}/requirements.txt
-r{toxinidir}/doc/requirements.txt
whitelist_externals = rm whitelist_externals = rm
commands = commands =
rm -rf releasenotes/build rm -rf releasenotes/build