History

zhangdebo 77053a1296 Fix typo Change-Id: I4968e6eb438e43859fe63044ae580a059a52239a		2018-05-22 16:45:58 +08:00
..
source	Fix typo	2018-05-22 16:45:58 +08:00
specs	Replace Chinese punctuation with English punctuation	2018-05-17 12:28:20 +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
requirements.txt	Updated from global requirements	2018-03-15 08:09:41 +00: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.