Johan Dahlin wrote:
I would hesitate to include these in the tarball because of their size. The reference manual html is 710kB and the tutorial is 2.3MB. The source for these is about the same.There are a couple of things wrt to the documentation that I'd like to change/solve before 2.4.
1) Include the reference manual in the pygtk tarball (like in gtk+)
2) Likewise for the tutorial
3) Generate .devhelp files on the fly
What are these?
I find the GTK/GDK documentation index really confusing and fragmented and it's hard to find where a particular reference page is. I much prefer an alphabetical listing. We could have both types of indexes, I suppose.4) Change the index to match the gtk+ documentation a bit more (like this: http://developer.gnome.org/doc/API/2.0/gtk/). Might not be possible/sane to do it the exact same way, because we're wrapping glib/atk/pango/gdk/gtk in the same package and it would create a huge index file to have everything in the same
Does this mean that if you change the PyGTK API or add to it that you must also change the documentation or that you can't change the documentation unless there is an API change or addition? I'm guessing the former but I could interpret the wording as the latter.And once 1) is done, change commit policy so an api/change addition is required to add/change the appropriate documentation so it stays updated.
There is a bug filed about trying to generate the reference documentation from the source code. It might be worth considering if that could be done. The current automatic doc generation uses the GTK source which is often wrong.
John
_______________________________________________ pygtk mailing list [EMAIL PROTECTED] http://www.daa.com.au/mailman/listinfo/pygtk Read the PyGTK FAQ: http://www.async.com.br/faq/pygtk/
