openstack/heat

History

Zane Bitter 426aa3498b Clarify resource deprecation process The deprecation process is unclear in that it does not specify the goals of hiding (rather than removing) obsolete resource types. This has led to resources being hidden without removing their implementation, leaving existing stacks potentially inoperable. State clearly the purpose of hidden resource types, and options available to help users migrate. Change-Id: I7362c094122066f98a5c95d4c5da16cb5a5c1108		2018-02-20 14:53:49 -05:00
..
source	Clarify resource deprecation process	2018-02-20 14:53:49 -05: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.