openstack/openstack-manuals
Code Issues Proposed changes
cfc0dabfb3
openstack-manuals/doc/hot-reference/README.rst
Gauvain Pocentek 5de719a92a Create the HOT reference book 
The content of this book is mostly autogenerated from the heat source
code using the generate-reference.sh script and
openstack-doc-tools>=0.18.

Implements: blueprint heat-templates
Change-Id: Ia00ec6debdab3fe6038683aad01b025a9ff6702b
2014-10-03 06:44:43 +02:00

649 B
Raw Blame History

HOT Reference

This documentation is mostly generated from the heat source code, and files in the generated/ directory should not be edited manually. To make changes to these files, modify the heat docstrings, then regenerate the files (see the next section).

How to generate the content

  • Clone the heat source code:
git clone git://git.openstack.org/openstack/heat
  • Run the tools/generate-reference.sh script:
pip install 'openstack-doc-tools>=0.18'
tools/generate-reference.sh path/to/heat/clone
  • Check the build:
mvn clean generate-sources
# or
tox