History

Ryan Brown 6eab982dad Remove rst2script.sed and integration.sh rst2script.sed was referenced in the Fedora getting started documentation, but the recommended way to use Heat/Openstack on Fedora is now to use RDO/packstack. Also removes the reference to rst2script.sed in the getting_started/on_fedora documentation. Also removes obsolete integration.sh script. Partial-Bug: 1338066 Change-Id: I7f2b0d84ccef324ccb8e32ca4c6d90f9a3f2dda3		2014-07-25 12:40:36 -04:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Remove rst2script.sed and integration.sh	2014-07-25 12:40:36 -04: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

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.

Just type make to get help:

make

It will list available build targets.

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

If you modify doc files, you can type:

make doctest

to check whether the format has problem.