History

Peter Razumovsky a871b70be9 Fix resources allocation in documentation Allocation of contributed resources generates incorrectly, so this patch fixes res allocation. Now contributed resources are in Contributed Heat Resource Types page and integrated are in OpenStack Resource Types page. Escaping from using env because of all_resources loaded from PluginMapping. Change-Id: I6d7c501f231c546f909c3ed7f19fc8d1fc04e927 Closes-bug: #1433675		2015-04-07 14:15:47 +00:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Fix resources allocation in documentation	2015-04-07 14:15:47 +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

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.