Suggestions for documentation generation?

Terry Hancock hancock at anansispaceworks.com
Thu Mar 2 06:04:16 CET 2006


On Wed, 01 Mar 2006 19:58:50 -0500
"John M. Gabriele" <john_sips_teaz at yahooz.com> wrote:
> kpd wrote:
> > I have written a C++ library that I've then wrapped with
> > Pyrex. Any suggestions to the best-in-class tool to
> > create documentation for the libraries?
> > 
> > I would love to document things in one spot (could be
> > the code) and generate html and PDF from there.
> > 
> > Doxygen (www.doxygen.org) looks to be about the best so
> > far. 
> 
> I've heard that some folks use pythondoc:
> http://starship.python.net/crew/danilo/pythondoc/
> http://effbot.org/zone/pythondoc.htm
> 
> There's also HappyDoc http://happydoc.sourceforge.net/
> and EpyDoc http://epydoc.sourceforge.net/ .

Those are great, but I don't think they handle C++ ;-)

Which makes me wonder -- will epydoc work on a pyrex or
C-extension file if it defines the __doc__ strings?

-- 
Terry Hancock (hancock at AnansiSpaceworks.com)
Anansi Spaceworks http://www.AnansiSpaceworks.com




More information about the Python-list mailing list