> Are the benefits so big, though? I don't think it's such a big problem
> to include in the doc/ directory a README that points to the
> downloadable tarballs and CVS -- whoever wants the file will be happy to
> download it, and who doesn't isn't bothered by the extra time to pull

Yes, having it installed on all boxes which ships with PyGTK (Red
Hat/Fedora) vs not having it makes a big deal. I'll be much easier to
push it into distributions than including it separately.

600k is nothing this days. period.

> > 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.
> 
> These would be generated from the HTML docs themselves?

Not from HTML, but from the xml. It needs to be coordinated with the
html doc generation though, so archor links can be pointed to the
correct section.

> The way I see it is that it all depends on how we're going to treat the
> reference docs; whether we want to continue maintaining them
> independently, or take it under the pygtk.org code people to maintain it
> now that it's been "completed". I'd like to defer to John this decision,
> for the obvious reasons.

Me too. But at least a bug could be opened or so for known documentation
tasks when the contributor(s) are to lazy to update.

> > 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.
> 
> John's intent is perhaps similar to mine here -- if we want to make
> maintenence of the docs easier and more easily integratable to our code
> contributions, then this could be the ideal solution. As long as someone
> has time to dissect the docs, add them to the correct spots, and change
> the generation scripts. It does sound like a lot of work, now that I
> think about it. :-)

I'm happy with that too. But I don't think I'm going to spend a lot of
time implement it. Anyway, not everything can be generated, but I guess
something like function indexes (similar to gtk-doc ones).
But arguments to functions can't really be generated, since we're adding
our own argument parsing here and there. It's not as simple as in C
where you can just look at the function prototype unfortunately.
-- 
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