openstack/heat

History

Shilla Saebi 179da8704c changed heat dev docs to comply with conventions With the incorporation of many projects within OpenStack, it's very important to use standards in the documentation This is important for formalization as well as consistency the proper usage is: heat or Orchestration or Orchestration module heat should not be capitalized https://wiki.openstack.org/wiki/Documentation/Conventions Change-Id: Icbc213ecf2f564981e8a1595b5fc557d1b218f9c		2015-04-25 01:00:39 -04:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	changed heat dev docs to comply with conventions	2015-04-25 01:00:39 -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.