Ziad Sawalha f6141a6773 docs: autogenerate docs w/ module docstrings

Change-Id: I89c5982ceb9606b462a140ea2ea664615245e93e

2014-03-19 08:51:10 -05:00

Building the developer docs

Dependencies

You'll need to install python Sphinx package package:

sudo pip install 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.