Merge "Follow the new PTI for document build"

This commit is contained in:
Zuul 2018-08-21 21:11:26 +00:00 committed by Gerrit Code Review
commit 3945de8f27
4 changed files with 11 additions and 13 deletions

7
doc/requirements.txt Normal file
View 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

View File

@ -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

View File

@ -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

View File

@ -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