openstack/heat

History

Zane Bitter 7e699d184c Docs: Autogenerate config documentation The documentation we had of Heat's config options was static and had last been updated for the Ocata release. Ensure the documentation is kept up to date by automatically generating it from the source when the docs are built. Change-Id: I06b3848451541f8f2d98748c06c556b9dc1104c6		2018-04-27 15:37:17 -04:00
..
source	Docs: Autogenerate config documentation	2018-04-27 15:37:17 -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
requirements.txt	Updated from global requirements	2018-03-17 08:29:48 +00: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.