openstack/heat

History

Zane Bitter 9e6c3212b9 Add U + V release codenames for docs generation This makes for nicer output in the resource types docs. Change-Id: I5c7b0e7454df0c5dd33efb03c08d15ea231bf530		2020-08-12 10:06:35 -04:00
..
source	Add U + V release codenames for docs generation	2020-08-12 10:06:35 -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	Switch to newer openstackdocstheme and reno versions	2020-05-21 09:43:55 +02: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.