openstack/api-site
Code Issues Proposed changes

Add docs target, build as part of checkbuild

Browse Source 
Add docs target that lists those firstapp targets that are currently
supported. Adjust .gitignore to ignore all build results.

Change firstapp commands so that we have separate build directories per
variant.

Change-Id: I7c5120b1af2de2c3df8f59fe29678e736368365f
This commit is contained in:
Andreas Jaeger 2015-04-21 08:26:27 +02:00
parent e130f2e8bc
commit 7d0c7c290e
2 changed files with 32 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -18,4 +18,4 @@ target/
*~ *~
.*.swp .*.swp
.bak .bak
build/ /openstack-firstapp/build*/

39
tox.ini
View File

@ -8,7 +8,10 @@ basepython = python2.7
setenv = setenv =
VIRTUAL_ENV={envdir} VIRTUAL_ENV={envdir}
deps = -r{toxinidir}/test-requirements.txt deps = -r{toxinidir}/test-requirements.txt
whitelist_externals = bash whitelist_externals =
bash
mkdir
rsync
[testenv:venv] [testenv:venv]
commands = {posargs} commands = {posargs}
@ -31,7 +34,20 @@ commands =
commands = openstack-doc-test --check-deletions {posargs} commands = openstack-doc-test --check-deletions {posargs}
[testenv:checkbuild] [testenv:checkbuild]
commands = openstack-doc-test --check-build {posargs} commands =
# Build and copy RST Guides
# Include only environments that are (partially) written
# TODO(ajaeger): We publish to content to allow for reviewing, this needs a
# change of openstack-doc-tools to remove content here in the file layout
# for previewing.
sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build-libcloud/html
mkdir -p publish-docs/openstack-firstapp-libcloud/content
rsync -a openstack-firstapp/build-libcloud/html/ publish-docs/openstack-firstapp-libcloud/content/
sphinx-build -E -W -t fog openstack-firstapp/doc/source openstack-firstapp/build-fog/html
mkdir -p publish-docs/openstack-firstapp-fog/content
rsync -a openstack-firstapp/build-fog/html/ publish-docs/openstack-firstapp-fog/content/
# Build DocBook Guides
openstack-doc-test --check-build {posargs}
[testenv:publishdocs] [testenv:publishdocs]
# Prepare documents (without www) so that they can get published on # Prepare documents (without www) so that they can get published on
@ -72,22 +88,29 @@ sitepackages=True
whitelist_externals = doc-tools-check-languages whitelist_externals = doc-tools-check-languages
commands = doc-tools-check-languages doc-tools-check-languages.conf publish all commands = doc-tools-check-languages doc-tools-check-languages.conf publish all
[testenv:docs]
commands =
# Include only environments that are (partially) written
sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build-libcloud/html
sphinx-build -E -W -t fog openstack-firstapp/doc/source openstack-firstapp/build-fog/html
[testenv:openstack-firstapp-libcloud] [testenv:openstack-firstapp-libcloud]
commands = sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build/html commands = sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build-libcloud/html
[testenv:openstack-firstapp-jclouds] [testenv:openstack-firstapp-jclouds]
commands = sphinx-build -E -W -t jclouds openstack-firstapp/doc/source openstack-firstapp/build/html commands = sphinx-build -E -W -t jclouds openstack-firstapp/doc/source openstack-firstapp/build-jclouds/html
[testenv:openstack-firstapp-fog] [testenv:openstack-firstapp-fog]
commands = sphinx-build -E -W -t fog openstack-firstapp/doc/source openstack-firstapp/build/html commands = sphinx-build -E -W -t fog openstack-firstapp/doc/source openstack-firstapp/build-fog/html
[testenv:openstack-firstapp-dotnet] [testenv:openstack-firstapp-dotnet]
commands = sphinx-build -E -W -t dotnet openstack-firstapp/doc/source openstack-firstapp/build/html commands = sphinx-build -E -W -t dotnet openstack-firstapp/doc/source openstack-firstapp/build-dotnet/html
[testenv:openstack-firstapp-node] [testenv:openstack-firstapp-node]
commands = sphinx-build -E -W -t node openstack-firstapp/doc/source openstack-firstapp/build/html commands = sphinx-build -E -W -t node openstack-firstapp/doc/source openstack-firstapp/build-node/html
[testenv:openstack-firstapp-openstacksdk] [testenv:openstack-firstapp-openstacksdk]
commands = sphinx-build -E -W -t openstacksdk openstack-firstapp/doc/source openstack-firstapp/build/html commands = sphinx-build -E -W -t openstacksdk openstack-firstapp/doc/source openstack-firstapp/build-openstacksdk/html
[testenv:openstack-firstapp-todos] [testenv:openstack-firstapp-todos]
commands = sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build/html commands = sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build/html