openstack/openstack-manuals
Code Issues Proposed changes
a39584ae61
openstack-manuals/doc/hot-reference
History
OpenStack Proposal Bot c44beb2e0e Imported Translations from Transifex 
Change-Id: I07736873c23ba5b35aa30b1edbd6ebb854e6c2e6
2014-10-14 07:24:23 +00:00
..
generated Rebuild the hot-ref with new IDs 2014-10-11 08:01:09 +02:00
locale Imported Translations from Transifex 2014-10-14 07:24:23 +00:00
bk-hot-reference.xml Create the HOT reference book 2014-10-03 06:44:43 +02:00
ch_overview.xml Create the HOT reference book 2014-10-03 06:44:43 +02:00
pom.xml Create the HOT reference book 2014-10-03 06:44:43 +02:00
README.rst Create the HOT reference book 2014-10-03 06:44:43 +02:00

README.rst

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