openstack/heat

History

ricolin c739be7645 Migrate doc path to contributor Migrate document contributing and developing_guides to contributor. Change-Id: I6308992451c8d65fb7c1b99c73b801bbf6152999		2020-02-22 14:16:50 +08:00
..
source	Migrate doc path to contributor	2020-02-22 14:16:50 +08: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	[ussuri][goal] Finish dropping python 2.7 support	2020-02-06 18:58:12 +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.