Ubuntu
accounts-qml-module package

Please create a documentation package

Bug #1195274 reported by David Planella
12
This bug affects 2 people
Affects Status Importance Assigned to Milestone
accounts-qml-module
Fix Released
Undecided
Unassigned
accounts-qml-module (Ubuntu)
Fix Released
Undecided
Unassigned

Bug Description

In order for app developers to be able to use the Online Accounts 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.

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!

Revision history for this message
Launchpad Janitor (janitor) wrote :

Status changed to 'Confirmed' because the bug affects multiple users.

Changed in accounts-qml-module (Ubuntu):
status: New → Confirmed
Revision history for this message
Alberto Mardegan (mardy) wrote :

The documentation is now up at developer.ubuntu.com

Changed in accounts-qml-module:
status: New → Fix Released
Changed in accounts-qml-module (Ubuntu):
status: Confirmed → Fix Released
Revision history for this message
David Planella (dpm) wrote :

Docs are at https://developer.ubuntu.com/api/qml/sdk-14.10/Ubuntu.OnlineAccounts/

The documentation package is accounts-qml-module-doc

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.