I want to do a little project with Epydoc just to get familiar with it. Something not too labor-intensive, but to get an idea what it can do.

• Epydoc usage
• Docstring conventions
• Annotating code for epydoc

The version of RST used in epydoc's docstrings is different from the version used in this file, because this file is built to HTML using rst2html. The Github repository for this project is on Github.

This looks like how you're supposed to use it:

rm -rf html/
epydoc -v -o html foo
x-www-browser html/index.html

Run this stuff in a virtualenv, like this:

virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

You can run a few doctest tests this way:

python foo/__init__.py