What's "the standard" for code docs?

cokofreedom at gmail.com cokofreedom at gmail.com
Wed Feb 20 03:25:43 EST 2008


On Feb 20, 9:12 am, "Diez B. Roggisch" <de... at nospam.web.de> wrote:
> > Are people really writing pure HTML snippets in docstrings to document
> > each module/class/method?  For anything other than a toy project?
>
> > One of the main reasons I'm considering moving to epydoc + reST is
> > precisely because it's very un-HTML.
>
> > Mind you I want to be able to produce HTML format docs from the
> > source, but I don't want to actually *put* HTML anywhere near my
> > precious sources.
>
> In the Java-world it *is* pure HTML snipplets... but no, not in python.
>
> Diez

Doxygen is your friend!



More information about the Python-list mailing list