GNOME Bugzilla – Bug 619377
Add nautilus-python documentation
Last modified: 2014-01-27 16:24:48 UTC
I recently release nautilus-python 0.7.0, which now has gtk-doc api reference and some additional overview material. http://ftp.gnome.org/pub/GNOME/sources/nautilus-python/0.7/ Could you please add the documentation to library.gnome.org? Thanks, Adam
library.gnome.org looks for a reference to gtk-doc.make in the Makefile.am files, but this doesn't work for nautilus-python, which does things differently. Could you change the way nautilus-python uses gtk-doc? Alternatively that detection could be bypassed, but it would require html files to be shipped in the tarball (which is a good thing to do anyway).
Can you explain how exactly I would need to change how nautilus-python uses gtk-doc? I don't know what to change based on what you said. I can release with the html files, how would I change the following line to make that happen? sh autogen.sh && make && make install && make distcheck Just add --enable-gtk-doc after sh autogen.sh?
http://library.gnome.org/devel/gtk-doc-manual/stable/settingup_automake.html.en starts with "First copy the Makefile.am from the examples subdirectory of the gtkdoc-sources to your project's API documentation directory ( ./docs/reference/<package>)."; this would be the first thing to do, at the moment you have docs/Makefile.am but not docs/reference/Makefile.am. This will also get all the correct calls to gtk-doc, instead of the handwritten rules you currently have in docs/Makefile.am (and this will get you html files automatically shipped in the tarball).
The problem with using that example Makefile.am is it assumes I am generating my documentation from my source code, and that is not the case here. nautilus-python doesn't really have any easy scannable source code, so the documentation is hand-written. All other python-bindings projects I've seen use something similar to what I have (I copied my Makefile.am code from other projects). What I'll do is build my tarball with a --enable-gtk-doc flag so it generates html files in the tarball.
I've had a heck of a time trying to get the html files included in the tarball. Using the instructions you linked to did not work for me, since it seems to force a code scan. I've looked at similar bindings projects such as pygobject, pygtk, and gnome-python, all projects that include the html files in the tarball, and I can't figure out how to produce the desired effect (FYI, doing make distcheck on pygobject fails). I've also looked at several other python bindings projects, such as pygtksourceview and pygoocanvas, and these projects do not include the html files in the tarball. I'd appreciate it if you could help me to figure out how to do this or give me a hint as to what I'm doing wrong. Thanks.
As I triaged bugs I went back to this but noticed nautilus-python didn't build anylonger, and maybe there's no support for it anymore in nautilus.