From ad862790dffbf9ae9ace673d706ef1ef2111f08c Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 14 Feb 2014 18:19:05 +0100 Subject: [PATCH] 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: I8fcc19cf0bc788f107622520d83743a000833b24 --- doc-test.conf | 7 ++++++- tox.ini | 14 ++++++++++---- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/doc-test.conf b/doc-test.conf index 081b272..5b143dd 100644 --- a/doc-test.conf +++ b/doc-test.conf @@ -2,8 +2,13 @@ repo_name = volume-api api_site = True -# These two options need to come as pairs: +# These options need to come together: book = v1 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 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 diff --git a/tox.ini b/tox.ini index 33bb1da..e585913 100644 --- a/tox.ini +++ b/tox.ini @@ -12,13 +12,19 @@ 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 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