← Back to team overview

touch-packages team mailing list archive

[Bug 1183013] Re: HTML documentation in the -doc package needs to use the online qdocconf file

 

raring has seen the end of its life and is no longer receiving any
updates. Marking the raring task for this ticket as "Won't Fix".

** Changed in: ubuntu-ui-toolkit (Ubuntu Raring)
       Status: New => Won't Fix

-- 
You received this bug notification because you are a member of Ubuntu
Touch seeded packages, which is subscribed to ubuntu-ui-toolkit in
Ubuntu.
https://bugs.launchpad.net/bugs/1183013

Title:
  HTML documentation in the -doc package needs to use the online
  qdocconf file

Status in Ubuntu UI Toolkit:
  Fix Released
Status in ubuntu-ui-toolkit package in Ubuntu:
  Fix Released
Status in ubuntu-ui-toolkit source package in Raring:
  Won't Fix

Bug description:
  While automating the API documentation to be published in
  developer.ubuntu.com I noticed that the header and footer were missing
  in the staging area I used to publish it.

  Expected (header and footer):
  http://developer.ubuntu.com/api/ubuntu-12.10/qml/mobile/overview-ubuntu-sdk.html

  Actual result in the staging area (no header and footer):
  http://developer.ubuntu.com/api/staging/devel/ubuntu-12.10/qml/ui-toolkit/overview-ubuntu-sdk.html

  This is due to the fact that:

  a) Documentation is extracted from the -doc package
  b) The -doc package is using the ubuntu-ui-toolkit-offline.qdocconf file to generate the documentation, where it should use ubuntu-ui-toolkit-online.qdocconf 

  We had a long conversation about this with greyback a while ago, and
  we agreed to use the online version of the config, as it would allow
  us to have the header and footer on the site, and having them in the
  local docs causes no harm.

  So if we could just switch to ubuntu-ui-toolkit-online.qdocconf we
  could then get daily updated documentation on the site :)

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu-ui-toolkit/+bug/1183013/+subscriptions