> >1) Include the reference manual in the pygtk tarball (like in gtk+)
> >
> >2) Likewise for the tutorial
> >
> 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.

Okay, maybe not the tutorial then since it's quite big. But I can't
really see why it's an issue to include another 600-700 k in the
tarball, the benefits are big.

> >3) Generate .devhelp files on the fly
> >
> What are these?

Basically a toc tree and a list of functions/methods.
Maybe you should try out devhelp and look at the .devhelp files to get
an idea how it works.

> 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.

For me it's the opposite, I find the list of classes quite bad,
especially for beginners. But for sure, both of them are needed.

> 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.

Ideally yes. I'm not sure if I can get everyone to agree on it though.

> 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.

I don't think it matters any longer. The bug was filed years before you
wrote the reference manual. We should probably just close that one and
live on.

-- 
Johan Dahlin <[EMAIL PROTECTED]>

_______________________________________________
pygtk mailing list   [EMAIL PROTECTED]
http://www.daa.com.au/mailman/listinfo/pygtk
Read the PyGTK FAQ: http://www.async.com.br/faq/pygtk/

Reply via email to