openstack/heat

History

Takashi Kajinami 1d155e48a2 Drop old excludes These excludes were removed from the requirements repo[1] and are now detected as errors. [1] 314734e938f107cbd5ebcc7af4d9167c11347406 Change-Id: I0399c328ecbf74529658d0be0f88868049e6ba5f		2024-04-30 15:35:45 +09:00
..
source	Merge "Fix minor typos in documentation"	2024-01-30 10:50:18 +00: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	Drop old excludes	2024-04-30 15:35:45 +09: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.