openstack/openstack-manuals
Code Issues Proposed changes
b8d665b11d
openstack-manuals/doc/hot-reference
History
OpenStack Proposal Bot 272ba07650 Imported Translations from Transifex 
For more information about this automatic import see:
https://wiki.openstack.org/wiki/Translations/Infrastructure

Change-Id: Iec451e9a1dade213848f4683ad1a9e91018d0ffb
2015-03-15 06:11:18 +00:00
..
generated Update the HOT reference guide 2015-03-11 16:30:12 +01:00
locale Imported Translations from Transifex 2015-03-15 06:11:18 +00:00
bk-hot-reference.xml Adds 2015 copyright year to book files 2015-01-07 11:17:30 +01: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 hot-ref README: fix the generation script name 2015-02-16 20:51:15 +01: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-hot-reference.sh script:
pip install 'openstack-doc-tools>=0.18'
tools/generate-hot-reference.sh path/to/heat/clone
  • Check the build:
mvn clean generate-sources
# or
tox