openstack-attic/netconn-api
Code Issues Proposed changes

Set up for publishing via openstack-doc-tools

Browse Source 
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
This commit is contained in:
Andreas Jaeger 2014-02-14 18:07:49 +01:00
parent 48f4b2a946
commit 84cf5475bf
2 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc-test.conf
View File

@ -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

15
tox.ini
View File

@ -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