senlin/doc
2015-01-14 13:00:52 +08:00
..
api-site Fix build info method error 2015-01-08 11:18:53 +08:00
docbkx Removed old files that are useless now 2015-01-14 13:00:52 +08:00
source Initial version 2015-01-01 14:25:13 +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 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.

Get Help

Just type make to get help:

make

It will list available build targets.

Build Doc

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

Test Doc

If you modify doc files, you can type:

make doctest

to check whether the format has problem.