JUN JIE NAN cd77745003 Doc usage enhancement

Enable doctest, correct depenencies section, adjust help and build
section.

Change-Id: I6c2f89d64926ee8e32b86299356700446903888b

2013-11-19 14:08:17 +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 oslo-sphinx package:

sudo pip install sphinx oslo-sphinx

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.