History

dixiaoli 9a5be23afa Doc fix This change fixed word typo in policy doc. Change-Id: Ida12fd1dd4d22b0f07d1ba694a94ce9374d43d31		2016-02-21 09:03:40 +08:00
..
docbkx	Revise 'Heat' to 'Senlin' in doc/docbkx/README.rst	2015-12-10 02:36:54 -05:00
source	Doc fix	2016-02-21 09:03:40 +08:00
specs	Add a specs directory to hold design proposals	2016-02-17 01:55:51 -05: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.