History

tengqm b9fd782106 Documentation on API changes There have been efforst to change Senlin API in an ad-hoc manner. Such kind of changes should be strictly reviewed. This patch clarifies the proper procedure to introduce API changes to Senlin. Change-Id: I63a7981d6dc639ca9b73768f4b921ab5f8996069		2017-01-07 04:41:56 -05:00
..
docbkx	Fix typos in Senlin files	2016-03-29 11:49:51 +07:00
source	Documentation on API changes	2017-01-07 04:41:56 -05:00
specs	Move approved spec into the 'approved dir	2016-11-14 21:20:20 -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.