openstack/heat

History

Brian Moss 670bf6d6cb Merge HOT Guide files into Template Guide The HOT Guide was formerly located in the User Guide. This patch merges those files into the heat docs repository in the Template Guide directory. Change-Id: I559b1b3edb42b1de40013c37e5967d8898c8a916 Closes-Bug: #1461720		2015-06-25 11:14:50 +10:00
..
docbkx	Change "ReST" to "REST" in developer doc	2015-06-03 21:26:29 +05:30
source	Merge HOT Guide files into Template Guide	2015-06-25 11:14:50 +10: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.