Best way to document Python code...

[Paddy]

Scott Huey wrote:

> I am working on a Python module and I would like to prepare some API
> documentaiton. I managed to find epydoc after some searching online.
>
> Is there a standard way to document the API for Python modules? Is
> epydoc the best way to go if there is no standard? Are there other ways
> to document a Python API?
>
> Thanks,
>
> Scott Huey

To add to the other replies: try adding a few doctests to your
docstrings. They can help show typical use cases even if you don't use
them for 'testing'  - and you can automatically keep the use cases
up-to-date.
http://en.wikipedia.org/wiki/Doctest

- Paddy.