History

ruijie 690bfdfc09 fix doc: update cluster size properties Change-Id: I7407e3b14020032008d423a15aae7f5692cefe4e Closes-Bug: #1708907		2017-08-06 08:28:15 -07:00
..
source	fix doc: update cluster size properties	2017-08-06 08:28:15 -07:00
specs	Update and optimize documentation links	2017-07-19 10:19:48 +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.