Re: PyGI documentation plans

[Tomeu Vizoso <tomeu tomeuvizoso net>]

On Mon, Jul 11, 2011 at 20:47, Dieter Verfaillie
<dieterv optionexplicit be> wrote:
> On 11/07/2011 13:51, Timo Vanwynsberghe wrote:
>> Hi all,
>>
>> I was wondering if there plans on making some PyGI (how should we call
>> it actually?) documentation. I always look at the GTK C reference,
>> which works pretty well most of the time, but I can imagine not
>> everyone feels ok with this approach. And then there are the cases
>> where PyGobject overrides classes/functions.
>>
>> Is there someone who already started this or is there some wiki
>> page/mail archive thread with a past discussion? I have some spare
>> time which I would like to spend on this if needed.
>
> I vaguely remember some mailinglist threads discussing this (searched
> for them on gtk-list, gtk-devel-list, pygtk-list and python-hackers-list
> but didn't find them?) that had a reference to this bug:
> https://bugzilla.gnome.org/show_bug.cgi?id=625494
>
> I know it's not much, but maybe the people reference in that
> bug report know the current status on this...

As far as I know, nobody is working on this currently, but the patch
in there (once rebased) should be a good start into it.

What I think it would benefit us the most right now would be deciding
where we want to go regarding documentation. Do we want exactly the
same we had before? or rather a single set of documents for all
languages?

By the Desktop Summit in August, several people will get together to
hack mostly on this, and now is a good moment to influence what will
result from that.

Some links:

http://blog.tomeuvizoso.net/2011/02/generating-api-docs-from-gir-files.html

http://blog.tomeuvizoso.net/2011/04/gobject-introspection-hackfest.html

http://live.gnome.org/Hackfests/Introspection2011

Regards,

Tomeu

> mvg,
> Dieter
> _______________________________________________
> python-hackers-list mailing list
> python-hackers-list gnome org
> http://mail.gnome.org/mailman/listinfo/python-hackers-list
>