Identify how to make API docs available on d.u.c

[Jono Bacon]

As part of developer.ubuntu.com, we want to ensure that API documentation is made available at http://developer.ubuntu.com/api

Achieving this poses a few challenges:

 * What documentation generating tools do we use for Ubuntu APIs (e.g. the indicator framework, notify-osd etc).
 * How do we automate the generation of those docs with each new release.
 * How do we ensure those docs are always available at http://developer.ubuntu.com/api, preferably within the theme of the wider d.u.c site.

This bug is here as a TODO item for following up on this work and led by David Planella.

[Jono Bacon (jonobacon)]

Can we also add Quickly Widgets to the list, dpm? Rick Spencer is a good person to talk to about that.

[David Planella (dpm)]

Just a quick status update:

We've been working with a wiki document to keep track of progress, which is now on the Ubuntu wiki:
https://wiki.ubuntu.com/DeveloperUbuntuComApi

The purpose of the list is to identify which Ubuntu APIs we are targeting to have documented on developer.ubuntu.com, as well as to help ensuring there is documentation available for them. We are tracking the progress of these tasks with bugs.

For Natty, the aim is to have C documentation for all of the targeted APIs on d.u.c. Looking forward, we'd like to provide documentation for all of the bindings in other programming languages post-Natty

For gobject-based APIs, the plan is to ensure they are all introspectable and to generate the documentation from the introspection file (.gir files). There has been some good progress on this, and Mikkel Kamstrup has been leading the effort of creating a tool for generating HTML from the XML-based introspection tools (https://code.launchpad.net/~kamstrup/+junk/giraffe). This will be an interim solution to have something until the equivalent functionality has been implemented upstream (gtk-doc or gobject-introspection).

For non-GObject-based APIs, we'll rely on Doxygen to generate the documentation.

Prior to publishing it to d.u.c, you can see the output of the currently documented APIs on http://people.canonical.com/~dpm/api/ (generated daily by https://code.launchpad.net/~dpm/+junk/apidoc-publish)