heat/doc/README.rst
Steve Baker c4777794e7 A new documention structure, ready for contributions
Here are some skeletons for the documentation which will need to be written.

doc/source
	A Sphinx based document which will be aimed at heat developers.
    	This also contains .rst files which generate the man files
doc/docbkx/api-ref
	Docbook and WADL for the REST API, with the intent of moving this
	to api-site to publish to api.openstack.org
doc/docbkx/heat-admin
	Docbook manual targeted at Heat admins, with the intent of moving this
        to openstack-manuals to publish to docs.openstack.org
doc/docbkx/heat-cli
	Docbook manual targeted at users of the Heat CLI, with the intent of
	moving this to openstack-manuals to publish to docs.openstack.org

Dude, wheres my man pages?
docs/man
	is deleted, now generated into doc/build/man

Packaging will need to be updated to generate the man pages

Change-Id: Idf2f37086b6f97df18ed57172de2f9e3d4c7706a
2012-12-19 10:22:35 +13:00

635 B

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