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: Iac8615f06ad31e9f6d17483374c23dfda47b9f84
changes/66/73666/1
Andreas Jaeger 9 years ago
parent
commit
8af17d7ab4
  1. 4
      doc-test.conf
  2. 13
      tox.ini

4
doc-test.conf

@ -2,6 +2,8 @@
repo_name = object-api
api_site = True
# These two options need to come as pairs:
# These three options need to come together:
book = openstack-object-storage-dev
target_dir = target/docbkx/webhelp/api/openstack-object-storage/1.0
# Published at http://docs.openstack.org/api/openstack-object-storage/1.0
publish_dir = api/openstack-object-storage/1.0

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