History

Anderson Mesquita b8e70c54d6 Generate docs for contrib plugins Extend write_autodoc_index to take the contrib plugins into account and force load all resources - both built-in and contrib - in ext/resources.py. Co-Authored-By: Richard Lee <rblee88@gmail.com> Partial-Bug: #1271226 Change-Id: If93dcae52bc573e2673d7fd76a0db62d5fc68115		2014-03-03 10:49:28 -05:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Generate docs for contrib plugins	2014-03-03 10:49:28 -05:00
.gitignore	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
Makefile	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
README.rst	Fix a typo in the README for docs	2013-12-24 16:08:41 +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 oslo.sphinx package:

sudo pip install sphinx oslo.sphinx

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.