History

Ziad Sawalha c382a3e860 Implement New Discovery Schema Change-Id: Ibd34c44211920197cf19df535ef038279fff2714		2014-05-07 15:25:05 -05:00
..
source	Implement New Discovery Schema	2014-05-07 15:25:05 -05:00
.gitignore	docs: autogenerate docs w/ module docstrings	2014-03-19 08:51:10 -05:00
Makefile	Prepare doc building	2014-01-28 16:18:14 -06:00
README.rst	docs: autogenerate docs w/ module docstrings	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.