senlin/doc
zzxwill 46fa9fc00f separate two different commands in two lines
In the doc senlin/doc/docbkx/README.rst, command
"cd senlin-admin mvn clean generate-sources" are two
different commands "cd senlin-admin" and "mvn clean generate-sources",
which should be in different lines.

Closes-Bug: 1550181
Change-Id: Ic213aa54d83b584f67911374abf6d26e500002e2
2016-03-01 03:09:58 +00:00
..
docbkx separate two different commands in two lines 2016-03-01 03:09:58 +00:00
source Merge "Documentation for deletion policy" 2016-02-29 09:04:53 +00:00
specs Add a specs directory to hold design proposals 2016-02-17 01:55:51 -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

README.rst

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.