diff --git a/doc-test.conf b/doc-test.conf index 63fb93b15..479fc4983 100644 --- a/doc-test.conf +++ b/doc-test.conf @@ -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 diff --git a/tox.ini b/tox.ini index 33bb1dabd..ec256ad26 100644 --- a/tox.ini +++ b/tox.ini @@ -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