[pygtk] Documentation strategy for bindings

BJörn Lindqvist bjourne at gmail.com
Tue Sep 4 01:18:04 WST 2007


Hello!

I'm interested to know what the best way (or maybe there are multiple
good ways) to write documentation for Python bindings for a GTK
library is.

What I would like, is for a way to get the documentation into the
docstrings, because then I get interactive help and can generate html
and pdfs using epydoc. However I'm not sure if the wrapper generator
in pygtk supports that? And even if it does, wouldn't it be a royal
pain in the ass to have to update all the documentation each time I
regenerate the wrapper?

Maybe wrapping using Pyrex or ctypes is a better approach if you want
high-quality documentation? Has anyone tried that?


-- 
mvh Björn


More information about the pygtk mailing list