openstack/heat

History

Matthias Runge 61e53c4eca Replace Fedora test image with F32 Fedora 31 was retired and the image is gone from mirrors. heat-cfntools have been dropped from fedora images, disable the test till that's resolved. Also makes grenade job non-voting, till this is backported to stable/victoria. Change-Id: Id869f83a46454897c2fe7a532eebfa2863befe5e		2020-12-04 12:18:59 +05:30
..
source	Replace Fedora test image with F32	2020-12-04 12:18:59 +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
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.