[C++-sig] Generating API documentation when using boost::python

James Amundson amundson at fnal.gov
Thu Apr 15 20:39:03 CEST 2010


On 04/15/2010 03:53 AM, Murray Cumming wrote:
> (If anyone can suggest a better alternative to nasty pydoc, I'd be
> glad.)
>    

Well, Sphinx, <http://sphinx.pocoo.org/>, is the new standard for Python 
documentation, but I don't think it has any way to extract documentation 
from your boost python module. For that purpose, I'm using Breathe, 
<http://github.com/michaeljones/breathe>, which takes the output of 
Doxygen and adapts it to Sphinx. It isn't perfect, but it seems useful. 
I think it has the potential to get much better.

--Jim Amundson


More information about the Cplusplus-sig mailing list