openstack/heat

History

Peter Razumovsky 4d42d61439 Fix docs about using SupportStatus during remove Fix docs about using SupportStatus for object after deprecation period. Also, fix several typos and format mistakes. Change-Id: I4d26f9977859ff845d7ff561cdd64180f5b848c4 Closes-bug: #1484868		2015-08-14 12:51:18 +03:00
..
docbkx	Change "ReST" to "REST" in developer doc	2015-06-03 21:26:29 +05:30
source	Fix docs about using SupportStatus during remove	2015-08-14 12:51:18 +03: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.