openstack/heat

History

rabi 6d55417f80 Remove CloudWatch API This patch removes the API, the next set of patches in the series would remove stack watch service and related WatchRule implementation. Change-Id: I8b0472be862907298c8da51f435b5d8b19610ec3 Partial-Bug: #1743707		2018-01-28 09:11:17 +05:30
..
source	Remove CloudWatch API	2018-01-28 09:11:17 +05:30
.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.