Re: Announce: Gjs documentation almost ready!

[Giovanni Campagna <scampa giovanni gmail com>]

2014-02-26 20:27 GMT+01:00 Giovanni Campagna <scampa giovanni gmail com>:
> Hello desktop developers,
>
> as some of you may have noticed, there has been some activity on the
> documentation generator for gobject-introspection, and in particular a
> lot of improvements on the Gjs side.
> Now the result are beginning to appear, and you can see them here:
> https://people.gnome.org/~gcampagna/docs/
>
> In particular, what is interesting is that we blend in generated and
> manually edited documentation. This allows us to remove all of GLib
> and GObject that is not interesting or badly annotated, and it lets us
> add things like GObject.Class (
> https://people.gnome.org/~gcampagna/docs/GObject-2.0/GObject.Class.html
> ), which is the gjs specific way to define new GTypes.
> I hope to finish with the other overrides soon (the biggest ones are
> GLib.Variant and Gio.DBus*, but there's some minor stuff), which
> should solve one of the greatest hurdles in taking up gjs programming.
> The sources for this generation are not hosted anywhere, because I
> don't know if it makes sense to store generated (or semi-generated)
> files in git. I think it does, at least for GLib and GObject, because
> the update is always manual. cairo has the same problem, because we
> bind it manually, and the "native" gjs modules need documentation too.
>
> Of course, this location is only temporary, and I hope we will move to
> library-web at some point. This would also fix the styling, which
> right now is "poor" (it's a pure yelp-build of the mallard docs).
> The interesting part, though, is that the documentation, at least for
> the schematic parts, is correct and existing.
>
> And naturally, help is welcome, but for now, enjoy!

A small update on this: I have pushed the mallard sources to a new
repository, gjs-documentation, togheter with the basic scripting to
recreate the html version. Additionally, I have completed the
documentation for the GLib and GObject overrides (so GLib.Variant.new
and [deep_]unpack() are covered now), they will be on people.gnome.org
soon.
We have a wiki page, Projects/Gjs/Documentation, tracking all the work
and all current issues, so more than ever, help is welcome :)

Giovanni