Set up for publishing via openstack-doc-tools

tox -e publishdocs will be called by the post jenkins jobs to prepare
everything for publishing - and then the content of publish-docs
gets copied.

Additionally, remove some parameter from openstack-doc-tools invocation,
they are now set in doc-test.conf.

Change-Id: I5966dfb1bbfa85a92b19eabc438218ea7d7b15cf
This commit is contained in:
Andreas Jaeger
2014-02-14 16:55:44 +01:00
parent 544a873711
commit 4032e8a50f
2 changed files with 13 additions and 7 deletions

View File

@@ -5,6 +5,9 @@ api_site = True
ignore_dir=incubation
ignore_dir=openstack-compute-api-1.0
# These two options need to come as pairs:
# These three options need to come together:
book = openstack-compute-api-2
target_dir = target/docbkx/webhelp/api/openstack-compute/2
# Published at http://docs.openstack.org/api/openstack-compute/2/
publish_dir = api/openstack-compute/2/

15
tox.ini
View File

@@ -12,15 +12,18 @@ deps = -r{toxinidir}/test-requirements.txt
commands = {posargs}
[testenv:checkniceness]
commands = openstack-doc-test --api-site --check-niceness {posargs}
commands = openstack-doc-test --check-niceness {posargs}
[testenv:checksyntax]
commands = openstack-doc-test --api-site --check-syntax {posargs}
commands = openstack-doc-test --check-syntax {posargs}
[testenv:checkdeletions]
commands = openstack-doc-test --api-site --check-deletions {posargs}
commands = openstack-doc-test --check-deletions {posargs}
[testenv:checkbuild]
# ignore directories incubation and openstack-compute-api-1.0, these are
# not published
commands = openstack-doc-test --api-site --check-build --ignore-dir=incubation --ignore-dir=openstack-compute-api-1.0 {posargs}
commands = openstack-doc-test --check-build {posargs}
[testenv:publishdocs]
# Prepare all documents so that they can get published on
# docs.openstack.org with just copying publish-docs/* over.
commands = openstack-doc-test --check-build --nocreate-index --force