From 63fef1141c52f1d8030f1b9efdd9400ca74b33dd Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 14 Feb 2014 18:00:12 +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: I81f93eb693a4c0e0527d2a9ab99790e516da97a8 --- doc-test.conf | 11 ++++++++--- tox.ini | 13 +++++++++---- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/doc-test.conf b/doc-test.conf index f00be7c..df088da 100644 --- a/doc-test.conf +++ b/doc-test.conf @@ -2,8 +2,13 @@ repo_name = image-api api_site = True -# These two options need to come as pairs: -book = openstack-image-service-api +# These three options need to come together: +book = image-api-v1 target_dir = target/docbkx/webhelp/api/openstack-image-service/1.1 -book = markdown +# Published at http://docs.openstack.org/api/openstack-image-service/1.1/ +publish_dir = api/openstack-image-service/1.1 + +book = image-api-v2 target_dir = target/docbkx/webhelp/api/openstack-image-service/2.0 +# Published at http://docs.openstack.org/api/openstack-image-service/2.0/ +publish_dir = api/openstack-image-service/2.0 \ No newline at end of file diff --git a/tox.ini b/tox.ini index 33bb1da..11fb53a 100644 --- a/tox.ini +++ b/tox.ini @@ -12,13 +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] -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. +commands = openstack-doc-test --check-build --nocreate-index --force