Enable publishing plugin docs

Adjusts tox env for building docs and release notes to global standards.
Enables publish-openstack-docs-pti template in Zuul config publish
plugin documentation.

Change-Id: I240803de5e47400f37092a802b300f9f18efd828
Signed-off-by: Bartosz Zurkowski <b.zurkowski@samsung.com>
This commit is contained in:
Bartosz Zurkowski 2018-10-31 12:05:50 +01:00
parent 6b4b2369c3
commit 22627b8160
4 changed files with 17 additions and 6 deletions

View File

@ -1,6 +1,7 @@
- project:
templates:
- check-requirements
- publish-openstack-docs-pti
- tempest-plugin-jobs
check:
jobs:

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

@ -4,7 +4,3 @@
hacking<0.13,>=0.12.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
# releasenotes
reno>=2.5.0 # Apache-2.0

11
tox.ini
View File

@ -36,12 +36,19 @@ commands =
[testenv:docs]
basepython = python3
commands = python setup.py build_sphinx
deps =
-r{toxinidir}/doc/requirements.txt
commands =
rm -rf doc/build
sphinx-build -W -b html doc/source doc/build/html
[testenv:releasenotes]
basepython = python3
deps =
-r{toxinidir}/doc/requirements.txt
commands =
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
rm -rf releasenotes/build
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[testenv:debug]
commands = oslo_debug_helper {posargs}