best practice for documenting a project? pydoc?

shaileshkumar shaileshk at gmail.com
Wed Aug 12 17:33:55 CEST 2009


Hello,

EPYDOC is very good for automatic generation of documentation from
source code.

You may also consider Sphinx http://sphinx.pocoo.org/ which is used
for many
projects including the official Python documentation, documentation of
Zope (http://docs.zope.org/).
See the full list of projects using Sphinx at http://sphinx.pocoo.org/examples.html

- Shailesh


On Aug 12, 7:49 pm, Mark Lawrence <breamore... at yahoo.co.uk> wrote:
> 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, seehttp://labix.org/python-constraintandhttp://labix.org/doc/constraint.
> I think they've been produced with epydoc seehttp://epydoc.sourceforge.net/
>
> --
> Kindest regards.
>
> Mark Lawrence.




More information about the Python-list mailing list