best practice for documenting a project? pydoc?

[Mark Lawrence]

Esmail wrote:
> Hello,
> 
> A project that I have been working on is getting larger
> and more complex, and I would like to unload some of the
> information from my memory/head to some other media (a
> set of web pages?). I am primarily interested in documenting
> the classes/methods.
> 
> This documentation is primarily for my use only - as I can't
> continuously work on this project and have to come back to it
> after some time, it would be nice to have some documentation
> available to help jog my memory.
> 
> What is the best way to do this in an automated way? I have
> been documenting my code as I've gone along.
> 
> Is pydoc still the way to go, or should I use something else?
> 
> Thanks,
> Esmail
> 
The docs for the constraint package look good, see
http://labix.org/python-constraint and http://labix.org/doc/constraint.
I think they've been produced with epydoc see http://epydoc.sourceforge.net/

-- 
Kindest regards.

Mark Lawrence.