History

Yuanbin.Chen 3ccaf651c5 User documents add cluster and node check and recover opertion Change-Id: If60636a295a1c3635fc07d66b52b1a1ec215dd0d Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>		2018-02-06 14:23:44 +08:00
..
source	User documents add cluster and node check and recover opertion	2018-02-06 14:23:44 +08:00
specs	Add fast scaling spec	2017-12-28 12:02:24 +08: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	Remove senlin-admin skeleton	2017-07-03 10:00:56 +02:00

Building the developer docs

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.