From 84cf5475bf2ff5382fc9c17aa0456ee634ebf015 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 14 Feb 2014 18:07:49 +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: If293f7af01e9df2efe37f93765de188c68ad6636 --- doc-test.conf | 8 +++++++- tox.ini | 15 ++++++++++----- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/doc-test.conf b/doc-test.conf index 34778e7..a789536 100644 --- a/doc-test.conf +++ b/doc-test.conf @@ -2,8 +2,14 @@ repo_name = netconn-api api_site = True -# These two options need to come as pairs: + +# These three options need to come together book = v1.0 target_dir = target/docbkx/webhelp/openstack-network +# Not published but needs to be configured +publish_dir = api/openstack-network/1.0 + book = v2.0 target_dir = target/docbkx/webhelp/openstack-network +# Published at http://docs.openstack.org/api/openstack-network/2.0 +publish_dir = api/openstack-network/2.0 \ No newline at end of file diff --git a/tox.ini b/tox.ini index e53d369..a9d2918 100644 --- a/tox.ini +++ b/tox.ini @@ -12,14 +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] -# ignore directory v1.0, it is not published -commands = openstack-doc-test --api-site --ignore-dir=v1.0 --check-build {posargs} +# Ignore directory v1.0, it is not published +commands = openstack-doc-test --check-build --only-book v2.0 {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 --only-book v2.0