9d230819a6
With Zuul v2, the publishing happens from publish-docs/api-ref. Let's simplify our scripts and publish with Zuul v3 from publish-docs directly. Add new jobs publishlang and publishbuild for Zuul v3 publishing. Use existing publishlang-api and publishbuild-api for Zuul v2 publishing. Remove now obsolete comment from doc-tools-check-languages.conf. Change-Id: I32b29a34c571882cb4d7c542c543ea726e76a0b5
151 lines
4.2 KiB
INI
151 lines
4.2 KiB
INI
[tox]
|
|
minversion = 1.6
|
|
envlist = checkniceness,checkbuild
|
|
skipsdist = True
|
|
|
|
[testenv]
|
|
basepython = python2.7
|
|
setenv =
|
|
VIRTUAL_ENV={envdir}
|
|
deps = -r{toxinidir}/test-requirements.txt
|
|
whitelist_externals =
|
|
bash
|
|
mkdir
|
|
mv
|
|
rsync
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
[testenv:checkniceness]
|
|
commands =
|
|
doc8 firstapp
|
|
doc8 api-quick-start
|
|
|
|
[testenv:linters]
|
|
# This will replace checkniceness with Zuul v3
|
|
commands = {[testenv:checkniceness]commands}
|
|
|
|
[testenv:checkbuild]
|
|
commands =
|
|
# Build and copy RST Guides
|
|
{toxinidir}/tools/build-all-rst.sh
|
|
# Build website index
|
|
{toxinidir}/tools/build-index.sh build
|
|
|
|
[testenv:publishdocs]
|
|
# Prepare documents (without www) so that they can get published on
|
|
# developer.openstack.org with just copying publish-docs/api-ref over.
|
|
commands =
|
|
# Build and copy RST Guides
|
|
{toxinidir}/tools/build-firstapp-rst.sh
|
|
# Build and copy API Quick Start
|
|
{toxinidir}/tools/build-api-quick-start.sh
|
|
# Build website index
|
|
{toxinidir}/tools/build-index.sh publish
|
|
|
|
[testenv:publishdocs-api]
|
|
# publishdocs will replace this, leave this in for transition
|
|
whitelist_externals =
|
|
mkdir
|
|
mv
|
|
commands =
|
|
{[testenv:publishdocs]commands}
|
|
# Now move everything to api-ref directory since that's where
|
|
# OpenStack CI expects it with this job.
|
|
# We need to move the content of publish-docs into publish-docs/api-ref.
|
|
# Tox does not allow us using wildcards here.
|
|
mkdir .newdir
|
|
# This renames publish-docs to api-ref
|
|
mv publish-docs .newdir/api-ref
|
|
mv .newdir publish-docs
|
|
|
|
[testenv:checklang]
|
|
whitelist_externals = doc-tools-check-languages
|
|
commands = doc-tools-check-languages doc-tools-check-languages.conf test all
|
|
|
|
[testenv:buildlang]
|
|
# Run as "tox -e buildlang -- $LANG"
|
|
whitelist_externals = doc-tools-check-languages
|
|
commands = doc-tools-check-languages doc-tools-check-languages.conf test {posargs}
|
|
|
|
[testenv:publishlang]
|
|
# Publish translated documents to developer.openstack.org with just
|
|
# copying publish-docs over.
|
|
whitelist_externals =
|
|
doc-tools-check-languages
|
|
mkdir
|
|
mv
|
|
rm
|
|
ls
|
|
commands =
|
|
# Cleanup first - important when this environment runs locally
|
|
# multiple times.
|
|
rm -rf publish-docs
|
|
doc-tools-check-languages doc-tools-check-languages.conf publish all
|
|
|
|
[testenv:publishlang-api]
|
|
# publishlang will replace this, leave this in for transition
|
|
whitelist_externals =
|
|
mkdir
|
|
mv
|
|
commands =
|
|
{[testenv:publishlang]commands}
|
|
# Now move everything to api-ref directory since that's where
|
|
# OpenStack CI expects it with this job.
|
|
# We need to move the content of publish-docs into publish-docs/api-ref.
|
|
# Tox does not allow us using wildcards here.
|
|
mkdir .newdir
|
|
# This renames publish-docs to api-ref
|
|
mv publish-docs .newdir/api-ref
|
|
mv .newdir publish-docs
|
|
|
|
[testenv:generatepot-rst]
|
|
# Generate POT files for translation, needs {posargs} like:
|
|
# tox -e generatepot-rst -- firstapp
|
|
commands = {toxinidir}/tools/generatepot-rst.sh api-site 0 {posargs}
|
|
|
|
[testenv:docs]
|
|
commands =
|
|
{toxinidir}/tools/build-all-rst.sh
|
|
|
|
[testenv:firstapp-libcloud]
|
|
commands = sphinx-build -E -W -t libcloud firstapp/source firstapp/build-libcloud/html
|
|
|
|
[testenv:firstapp-jclouds]
|
|
commands = sphinx-build -E -W -t jclouds firstapp/source firstapp/build-jclouds/html
|
|
|
|
[testenv:firstapp-fog]
|
|
commands = sphinx-build -E -W -t fog firstapp/source firstapp/build-fog/html
|
|
|
|
[testenv:firstapp-dotnet]
|
|
commands = sphinx-build -E -W -t dotnet firstapp/source firstapp/build-dotnet/html
|
|
|
|
[testenv:firstapp-pkgcloud]
|
|
commands = sphinx-build -E -W -t pkgcloud firstapp/source firstapp/build-pkgcloud/html
|
|
|
|
[testenv:firstapp-openstacksdk]
|
|
commands = sphinx-build -E -W -t openstacksdk firstapp/source firstapp/build-openstacksdk/html
|
|
|
|
[testenv:firstapp-todos]
|
|
commands = sphinx-build -E -W -t libcloud firstapp/source firstapp/build/html
|
|
|
|
[testenv:firstapp-shade]
|
|
commands = sphinx-build -E -W -t shade firstapp/source firstapp/build-shade/html
|
|
|
|
[testenv:firstapp-gophercloud]
|
|
commands = sphinx-build -E -W -t gophercloud firstapp/source firstapp/build-gophercloud/html
|
|
|
|
[testenv:api-quick-start]
|
|
commands =
|
|
{toxinidir}/tools/build-api-quick-start.sh
|
|
|
|
[doc8]
|
|
# Settings for doc8:
|
|
# Ignore target directories
|
|
ignore-path = firstapp/build*,common/
|
|
# File extensions to use
|
|
extensions = .rst,.txt
|
|
# Ignore lines longer than 79 chars
|
|
ignore = D001
|