[Zope-Annce] [Ann] DocFinder 1.0: ask Zope about its documentation

Dieter Maurer dieter at handshake.de
Tue Aug 26 02:06:29 EDT 2003


It is often difficult to find accurate documentation about the
Zope infrastructure. Often, I have written: look into the Zope source,
its source documentation is quite good. However, as Zope's implementation
language Python provides good introspection facilities, there
is a better way: extract the documentation directly from Zope.

That's what 'DocFinder' does. It analyses any
Zope object inside a running Zope, determines which classes
have been used in the object's makeup and provides information
about their class level attributes: name, allowed roles,
arguments, documentation strings. It provides (read only) access to
to source code of Python implemented classes and methods, as well.

What's new in version 1.0:

 * Direct access to source code of Python implemented classes and methods

 * Implemented as a single persistent <code>DocFinder</code> instance
   (rather than a DTML object and External Method pair)

 * Alternative URL-calling to document objects which intercept traversal

 * Now uses PageTemplates rather than DTML for presentation

More information and download:

     <http://www.dieter.handshake.de/pyprojects/zope/DocFinder.html>
     

Dieter



More information about the Zope-Announce mailing list