openstack/api-site
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 on docs.openstack.org - and then the content
of publish-docs gets copied.

tox -e publishdocs-api is the job for api.openstack.org.

Additionally, remove parameter --api-docs from
openstack-doc-tools invocation, it is set in doc-test.conf now.

Change-Id: I84986e1572d128b85ad43863217e4d6c0b22f41f
This commit is contained in:
Andreas Jaeger 2014-02-14 16:34:57 +01:00
parent 56a609a800
commit 314f7cca7a
2 changed files with 26 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc-test.conf
View File

@ -5,8 +5,15 @@ api_site = True
# From api-ref/src/wadls/object-api/src/
file_exception = os-object-api-1.0.wadl
# These two options need to come as pairs:
book=api-quick-start
target_dir=target/docbkx/webhelp/api-quick-start-onepager-external
book=api-ref
target_dir=target/docbkx/html
# These options need to come as triplets:
## API Quick Start Guide
book = api-quick-start
target_dir = target/docbkx/webhelp/api-quick-start-onepager-external
# Published at docs.openstack.org/api/quick-start
publish_dir = api/quick-start
## API Complete Reference
book = api-ref
target_dir = target/docbkx/html
# Published at api.openstack.org/api-ref
publish_dir = api-ref

18
tox.ini
View File

@ -12,13 +12,23 @@ 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]
commands = openstack-doc-test --api-site --check-build {posargs}
commands = openstack-doc-test --check-build {posargs}
[testenv:publishdocs]
# Prepare documents (without www) so that they can get published on
# docs.openstack.org with just copying publish-docs/* over.
commands = openstack-doc-test --check-build --nocreate-index --only-book api-quick-start
[testenv:publishdocs-api]
# Prepare documents (without www) so that they can get published on
# api.openstack.org with just copying publish-docs/* over.
commands = openstack-doc-test --check-build --nocreate-index --only-book api-ref