openstack-attic/volume-api
Code Issues Proposed changes

Set up for publishing via openstack-doc-tools

Browse Source 
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: I8fcc19cf0bc788f107622520d83743a000833b24
This commit is contained in:
Andreas Jaeger 2014-02-14 18:19:05 +01:00
parent 4963f3493b
commit ad862790df
2 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc-test.conf
View File

@ -2,8 +2,13 @@
repo_name = volume-api repo_name = volume-api
api_site = True api_site = True
# These two options need to come as pairs: # These options need to come together:
book = v1 book = v1
target_dir = target/docbkx/webhelp/api/openstack-block-storage/1.0 target_dir = target/docbkx/webhelp/api/openstack-block-storage/1.0
# Not published but needs to be configured
publish_dir = api/openstack-block-storage/1.0
book = v2 book = v2
target_dir = target/docbkx/webhelp/api/openstack-block-storage/2.0 target_dir = target/docbkx/webhelp/api/openstack-block-storage/2.0
# Published at http://docs.openstack.org/api/openstack-block-storage/2.0
publish_dir = api/openstack-block-storage/2.0

14
tox.ini
View File

@ -12,13 +12,19 @@ deps = -r{toxinidir}/test-requirements.txt
commands = {posargs} commands = {posargs}
[testenv:checkniceness] [testenv:checkniceness]
commands = openstack-doc-test --api-site --check-niceness {posargs} commands = openstack-doc-test --check-niceness {posargs}
[testenv:checksyntax] [testenv:checksyntax]
commands = openstack-doc-test --api-site --check-syntax {posargs} commands = openstack-doc-test --check-syntax {posargs}
[testenv:checkdeletions] [testenv:checkdeletions]
commands = openstack-doc-test --api-site --check-deletions {posargs} commands = openstack-doc-test --check-deletions {posargs}
[testenv:checkbuild] [testenv:checkbuild]
commands = openstack-doc-test --api-site --check-build {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.
# Currently only the v2 API gets published
commands = openstack-doc-test --check-build --nocreate-index --only-book v2