History

Haiwei Xu cafce3697a Update policy_types documentation The policy_types document is old, this patch updates it. Change-Id: I46ae0e575f7a96fd2b1c0017e993869355fa530d		2015-09-24 10:32:37 +09:00
..
api-site	Make profile schema versioned	2015-08-31 22:25:01 -04:00
docbkx	Removed old files that are useless now	2015-01-14 13:00:52 +08:00
source	Update policy_types documentation	2015-09-24 10:32:37 +09:00
.gitignore	Initial version	2014-12-15 00:02:08 +08:00
Makefile	Initial version copied from Heat	2014-12-10 17:21:00 +08:00
README.rst	Initial version copied from Heat	2014-12-10 17:21:00 +08: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.