best practice for documenting a project? pydoc?

E

Esmail

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
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

Forum statistics

Threads
473,769
Messages
2,569,582
Members
45,062
Latest member
OrderKetozenseACV

Latest Threads

Top