create documentation with the comments present in the source code

[Danyel Fisher]

Well, you certainly could write it yourself.
I guess.

But this is python, so there's only one right way to do it.

And that one way is to look up the ultra-handy PyDoc
(http://web.lfw.org/python/), written up by the ultra-clever Ping. If you
can handle ultra-pink, it will...
    * generate HTML documentation
    * serve it up in a local web server
    * make toast
    * document a module or a class

Danyel

"Dietmar Lang" <dietmar at nospam.wohnheim.fh-wedel.de> wrote in message
news:slrn9q3fqu.dh8.dietmar at trommel.fh-wedel.de...
> Hi!
>
> > As it is possible to put comment in 'python' code just after a function,
a
> > class as following :
> >
> > def Function():
> >     """
> >     My comment
> >     """
> >     if ...
> >
> > As it is possible to get this comment in the python command with an
simple
> > instruction...
>
> Yes, here's a little interactive session:
>
> >>> def Voila():
> """This is documentation for Voila()"""
> pass
>
> >>> print Voila.__doc__
> This is documentation for Voila()
> >>>
>
> There you go... If more details are needed, maybe someone here will jump
> in...
>
> > Is there an utility which realize a pretty documentation with these
comments
> > ?
>
> There propably is, else why don't you make one? ;)
>
> Kudos, Dietmar
>
> --
> To mail me, remove 'nospam.'.