Re: [HappyDoc-discuss] The Purpose

[Doug H. <do...@he...>]

Hi, Susie,

Sorry for the late reply - this got lost in my various inboxes because of a 
filter misconfiguration.

On Thursday 07 November 2002 10:32 pm, Susie wrote:
> I have been experimenting with various Python documentation tools.  I'd
> like to document the Module Name and some commented text at the beginning
> of the file, and hopefully in some readable format.  Is there some
> parameter on happydoc that I'm missing, which would include the starting
> comments? But I really don't need all the other info about the module
> (defs, etc.), so is there a simpler tool to use?

HappyDoc should be extracting the comments already.  Can you send example 
inputs and outputs?

> What was happydoc originally designed for?  How about similar documentation
> tools, like pydoc, pythondoc, docutils...  I guess that if I understand
> what the original purpose was, I might have a better sense of what would be
> best for my needs...

The original purpose was to document libraries of Python code to produce 
reference manuals for their use by other programmers.  I had one such library 
at the time, and did not want to have to keep up with the documentation 
separately from the source code.

One of the tools you left off of your list was epydoc.  I haven't looked at 
this one yet, but it might be of interest to you.

As far as I know, none of the other tools which parse Python code look at the 
comments for documentation.  I have not made an exhaustive study of the 
tools, though.

Doug