openstack/openstack-manuals
Code Issues Proposed changes
689774bd69
openstack-manuals/doc/hot-reference
History
OpenStack Proposal Bot c6d3d223b7 Imported Translations from Transifex 
Change-Id: If1738d18803862823ecbd417119f7f7eaa8950b1
2014-10-04 06:09:08 +00:00
..
generated Create the HOT reference book 2014-10-03 06:44:43 +02:00
locale Imported Translations from Transifex 2014-10-04 06:09:08 +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