Python source code documentation?

Jean-Claude Wippler jcw at equi4.com
Sat Jun 19 06:56:36 EDT 1999


Mark Hammond wrote:
> 
> Sam Schulenburg wrote in message <7kdv0l$n0g$1 at nnrp1.deja.com>...
> >I have been using a freeware product called Autoduck to document my
> >Python source code.
> 
> Cool!  I use AutoDuck to document all my Python extension C++ code.
[...] 
> However, depending on how far you have gone with AutoDuck,
> pythondoc/gendoc isnt solving the exact same problem.  Well, they all
> attempt to solve the same problem, but have different strengths.

Another package you may want to look at is Mark Peskin's Perceps:
	http://friga.mer.utexas.edu/mark/perl/perceps/
The following site docs for a C++ library were done with it (frames and
all, but I didn't want to activate the Java class hierarchy browser):
	http://www.equi4.com/metakit/info/docs/

Perceps was written in that other p-language, last time I checked.

'nother idea, since we have some many of these tools, and so many
languages (including SWIG, which also disects definitions), why not
define a "language -> XML" defs/docs extractor, plus a package which
turns that into docs, pdf's, help files, web sites (indexed), and such?

-- Jean-Claude




More information about the Python-list mailing list