diff options
author | Jay Dobies <jason.dobies@redhat.com> | 2016-05-04 15:23:15 -0400 |
---|---|---|
committer | Jay Dobies <jason.dobies@redhat.com> | 2016-05-04 15:46:28 -0400 |
commit | 4170566618426960b0ac850ba8e41a5f73b95c5e (patch) | |
tree | 15ed3c18cdd192a96de15fc1436beba150a6a48f /tox.ini | |
parent | 2f9b344c67e8522a7c8a32c8c4a9e2f5eba648a8 (diff) | |
download | heat-4170566618426960b0ac850ba8e41a5f73b95c5e.tar.gz |
Migrate API documentations into the Heat tree
For more information, see:
http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html
This is the initial port from api-site. The includes in
source/v1/index.rst are alphabetized, but we may want to revisit that
and reorder them according to importance.
Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048
Implements: blueprint api-doc-migration
Diffstat (limited to 'tox.ini')
-rw-r--r-- | tox.ini | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -54,6 +54,24 @@ deps = -r{toxinidir}/requirements.txt sphinxcontrib-httpdomain commands = python setup.py build_sphinx +[testenv:api-ref] +# This environment is called from CI scripts to test and publish +# the API Ref to developer.openstack.org. +# +# NOTE(sdague): this target does not use constraints because +# upstream infra does not yet support it. Once that's fixed, we can +# drop the install_command. +# +# we do not used -W here because we are doing some slightly tricky +# things to build a single page document, and as such, we are ok +# ignoring the duplicate stanzas warning. +whitelist_externals = bash + rm +install_command = pip install -U --force-reinstall {opts} {packages} +commands = + rm -rf api-ref/build + sphinx-build -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html + [testenv:genconfig] commands = oslo-config-generator --config-file=config-generator.conf |