openstack/heat

History

Angus Salkeld d08101eef6 Add a man page for heat-manage Change-Id: I9b3d6b3b227ca2a2a2786837b941fdc420d3b2b6 Closes-bug: #1189651		2013-11-01 21:55:53 +11:00
..
docbkx	Begin 3 chapters for Orch API Ref Manual	2013-10-09 10:04:33 -05:00
source	Add a man page for heat-manage	2013-11-01 21:55:53 +11:00
.gitignore	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
Makefile	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
README.rst	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00

README.rst

Building the developer docs

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

Dependencies

Sphinx

You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the cinder modules.

sudo yum install python-sphinx
sudo pip-python install sphinxcontrib-httpdomain

Use make

Just type make:

make

Look in the Makefile for more targets.

To build the man pages:

make man

To build the developer documentation as HTML:

make html