Browse Source

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: I4002ceec14608666ef14804f81a5edb95803d74b
changes/48/73648/2
Andreas Jaeger 9 years ago
parent
commit
175cf89703
  1. 7
      doc-test.conf
  2. 13
      tox.ini

7
doc-test.conf

@ -2,8 +2,13 @@
repo_name = identity-api
api_site = True
# These two options need to come as pairs:
# These three options need to come together
book = v2.0
target_dir = target/docbkx/webhelp/api/openstack-identity-service/2.0
# Published at http://docs.openstack.org/api/openstack-identity-service/2.0/
publish_dir = api/openstack-identity-service/2.0
book = v3
target_dir = target/docbkx/webhelp/api/openstack-identity-service/3
# Published on http://docs.openstack.org/api/openstack-identity-service/3
publish_dir = api/openstack-identity-service/3

13
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

Loading…
Cancel
Save