History

lvdongbing 25ee32a23b Add developer doc for osprofiler Change-Id: I7e17b08a245a26322fdb8287a2244235e140d9ae		2016-10-26 03:59:30 -04:00
..
docbkx	Fix typos in Senlin files	2016-03-29 11:49:51 +07:00
source	Add developer doc for osprofiler	2016-10-26 03:59:30 -04:00
specs	Merge "Fix a typo in template.rst"	2016-09-22 15:33:54 +00: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.