openstack
/
heat
Code Issues Proposed changes
heat/doc
History
Joe D'Andrea 88a216c491 Adds resource uuid, volume support to lifecycle scheduler hints 
Heat resources are now assigned an orchestration id prior to their
instantiation by nova, cinder, et. al. This id is now added to
stack lifecycle scheduler hints. In addition to nova receiving
such hints, cinder is also now supported.

Conflicts (all resolved):

  heat/common/config.py
  heat/engine/resources/aws/ec2/instance.py
  heat/engine/resources/openstack/cinder/volume.py
  heat/engine/resources/openstack/nova/server.py
  heat/tests/openstack/test_volume.py
  heat/tests/test_server.py

Change-Id: I5a13feb1bdedfbbe44de15e3d9eae72e56ec8a25
Closes-Bug: #1476345
(cherry picked from commit b31259a9ed)
 		2015-09-18 06:11:17 +00:00
..
docbkx Remove heat-cli-guide 2014-01-15 08:41:48 +01:00
source Adds resource uuid, volume support to lifecycle scheduler hints 2015-09-18 06:11:17 +00:00
.gitignore A new documention structure, ready for contributions 2012-12-19 10:22:35 +13:00
Makefile Makefile option to build xml docs 2014-07-02 22:08:01 +02:00
README.rst Switch over to oslosphinx 2014-02-13 18:45:57 +01:00

README.rst

Building the developer docs

For user and admin docs, go to the directory doc/docbkx.

Dependencies

You'll need to install python Sphinx package and oslosphinx package:

sudo pip install sphinx oslosphinx

If you are using the virtualenv you'll need to install them in the virtualenv.

Get Help

Just type make to get help:

make

It will list available build targets.

Build Doc

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

Test Doc

If you modify doc files, you can type:

make doctest

to check whether the format has problem.