Quick Reference from module doc strings.

[Ron Adam]

Michele Simionato wrote:
>>Do you have any feature suggestions, additional information that
> 
> could
> 
>>go in, something that would extend the content in some way and make
> 
> it
> 
>>more useful?
> 
> 
> I have written something similar which I use all the time. It generates
> ReST
> output which I can browse with "less" from the command line, as well as
> HTML
> output and PDF output that I can print. The hard work is done by
> docutils, of course.
> I have options to specify if I want to least private names or not, and
> to specify
> if I want an analytical index to be generated or not. Also, the HTML
> output
> contains hyperlinks to the original source code, so I can see  it with
> a click.
> I can feed to "minidoc" whole packages (it works recursively on
> subpackages, so everything is documented).
> 
> It was unvaluable in my struggle with Zope.
> 
>             Michele Simionato
> 

Hi Michele,

Sound great!  Adding a command line parser, I'm going to add a brief 
command line parser to it today, but nothing as elaborate as you have 
already.  Could you post a part of the output as an example?  How is the 
index built?

The direction I'm going is to build a database/dictionary with each 
individual item as a record. Maybe feed it the whole lib directory, then 
to be able to generate cross module/package lists by subject or keyword. 
  I'm not exactly sure how to connect everything together yet.  This is 
a figure it out as I go project, but I think it's worth trying.

Cheers,
_Ron