Please create a documentation package for the U1db QML module

[David Planella]

In order for app developers to be able to use the U1db API, we need good documentation.

Ideally, we'd have well documented examples, classes and its members, but the very first step is to get documentation built at all.

In the same way we do with the ubuntu-ui-toolkit, we need a -doc package for the accounts QML module, which builds and ships the HTML documentation generated from qdoc. Once we've got that, I can get that documentation to be automatically published on developer.ubuntu.com from the -doc package.

Alternatively, if the U1 bindings are considered part of the SDK, the U1db documentation could also be shipped in the ubuntu-ui-toolkit-doc package.

The ubuntu-ui-toolkit-doc package and ubuntu-ui-toolkit branch (see the documentation folder) are a good example about creating the HTML with developer.ubuntu.com CSS styling.

Thanks!

[Cris Dywan (kalikiana)]

The docs built from libu1db-qt5-doc are here:
 http://developer.ubuntu.com/api/devel/ubuntu-13.10/qml/u1db/overview.html

[David Planella (dpm)]

Yep, we built those docs manually back then, but now I know there is a package, so I'll use that for the doc publisher and mark the bug as invalid. Thanks!

[Cris Dywan (kalikiana)]

Looks like packages are again silently broken:
https://launchpad.net/~ubuntu-sdk-team/+archive/ppa/+packages

[Cris Dywan (kalikiana)]

See bug 1195311

[Kevin Wright (kevin-wright-1)]

"if the U1 bindings are considered part of the SDK, the U1db documentation could also be shipped in the ubuntu-ui-toolkit-doc package."

While still assuming U1db-Qt will be (or is) a contribution to the Ubuntu SDK, from an information architecture perspective, a database plugin/API's documentation should probably be treated independent of a user interface plugin's documentation.

They might be used together in applications, and live side by side together as plugins available to developers, but neither is a part of the other (and in this particular case neither one depends on the other as well).