History

Hangdong Zhang 122e117909 Update and optimize documentation links 1. Update the dead and outdated links 2. Optimize (e.g. http -> https) Change-Id: I2ca308e9e14929aecf595f431f819cac7a365602		2017-07-19 10:19:48 +08:00
..
source	Update and optimize documentation links	2017-07-19 10:19:48 +08: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.