After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 341527 - API documentation and inline documentation
API documentation and inline documentation
Status: RESOLVED OBSOLETE
Product: GStreamer
Classification: Platform
Component: gst-python
git master
Other Linux
: Normal enhancement
: git master
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2006-05-12 07:23 UTC by Edward Hervey
Modified: 2012-12-17 11:30 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Edward Hervey 2006-05-12 07:23:25 UTC 
It's about time we satisfy all python devs who want to use gst-python out there with good pythonic documentation.

Two things needed:
_A/ inline documentation (pydoc gst). The reason we don't do that, is because it would increase the memory usage when loading gstpython. All the same, we should look into it. The new pygtk codegenerator allows to inline documentation in the .defs.

_B/ pygtk-like html documentation (see http://pygtk.org/pygtk2reference/index.html). Some work was already started here : http://pygstdocs.berlios.de/

We should look into using both the codegenerator and the gstreamer/docs/gst/*.xml to help use generate that.
Comment 1 Johan (not receiving bugmail) Dahlin 2006-05-12 11:40:14 UTC 
This is related to bug 100309

There's a beginning of such a tool:

http://cvs.gnome.org/viewcvs/gnome-python/pygtk/codegen/docgen.py?view=markup
Comment 2 Mark Heslep 2006-05-24 19:17:24 UTC 
Add me to list of those willing to help
Comment 3 David Laban 2009-09-25 09:28:10 UTC 
Can I be cheeky and revive this bug? Having easily accessible docs is actually quite important to the whole "rapid application development" aspect of python.
Comment 4 Sebastian Dröge (slomo) 2012-12-17 11:30:57 UTC 
Closing this bug now, gst-python is only an extension module to pygi now and this bug doesn't make much sense anymore in this context.