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 detials information, please refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: I10537cf02d83f127b6932fa3f427043fb267d8b1 Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
parent
f6069e9e42
commit
fa12452bbd
7
doc/requirements.txt
Normal file
7
doc/requirements.txt
Normal file
@ -0,0 +1,7 @@
|
||||
# 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.
|
||||
|
||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||
reno>=2.5.0 # Apache-2.0
|
@ -34,12 +34,6 @@ oslo.config.opts =
|
||||
console_scripts =
|
||||
convert-json = oslo_log.cmds.convert_json:main
|
||||
|
||||
[build_sphinx]
|
||||
all-files = 1
|
||||
warning-is-error = 1
|
||||
source-dir = doc/source
|
||||
build-dir = doc/build
|
||||
|
||||
[upload_sphinx]
|
||||
upload-dir = doc/build/html
|
||||
|
||||
|
@ -14,10 +14,5 @@ oslotest>=3.3.0 # Apache-2.0
|
||||
# deps = {[testenv]deps} coverage
|
||||
coverage>=4.5.1 # Apache-2.0
|
||||
|
||||
# this is required for the docs build jobs
|
||||
sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD
|
||||
openstackdocstheme>=1.20.0 # Apache-2.0
|
||||
reno>=2.7.0 # Apache-2.0
|
||||
|
||||
# Bandit security code scanner
|
||||
bandit>=1.1.0 # Apache-2.0
|
||||
|
6
tox.ini
6
tox.ini
@ -30,11 +30,13 @@ commands = {posargs}
|
||||
|
||||
[testenv:docs]
|
||||
basepython = python3
|
||||
commands = python setup.py build_sphinx
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
commands = sphinx-build -a -E -W -b html doc/source doc/build/html
|
||||
|
||||
[testenv:releasenotes]
|
||||
basepython = python3
|
||||
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
commands = sphinx-build -a -E -W -b html releasenotes/source releasenotes/build/html
|
||||
|
||||
[testenv:cover]
|
||||
basepython = python3
|
||||
|
Loading…
Reference in New Issue
Block a user