Docs need a base URL in qdocconf file

Fix committed into lp:ubuntu-ui-toolkit at revision None, scheduled for release in ubuntu-ui-toolkit, milestone Unknown

Christian, can you provide some more context as to why exactly this is needed and how will this affect the generated HTML docs?

My concern is that we're hardcoding a path, which will change very soon when the 'ubuntu-13.04' online docs get published, and I'd like to understand how will this affect them.

Thanks.

Whenever HTML is generated and qdoc cross-references for example "AbstractButton" or "Ubuntu User Interface Toolkit" it puts the URL in front of the filename. This is required because not all documentation is in the same spot. If the URL changes, all places where it's used will automatically update once qdoc runs again - the URL is only hard-coded in the package itself.

Al 02/05/13 08:39, En/na Christian Dywan ha escrit:
> Whenever HTML is generated and qdoc cross-references for example
> "AbstractButton" or "Ubuntu User Interface Toolkit" it puts the URL in
> front of the filename. This is required because not all documentation is
> in the same spot. If the URL changes, all places where it's used will
> automatically update once qdoc runs again - the URL is only hard-coded
> in the package itself.
>

Thanks Christian for the clarification.

I'm still concern about hardcoding. There are two main reasons I can
think of it not working:

- We're going to have the 13.04 docs soon, and we cannot hardcode a
12.10 URL to it
- We'll also soon have SDK documentation both from the archive and
straight from the PPA. To differentiate them, I was planning to add the
/stable/ (for archive documentation) and /devel/ (for PPA documentation)

Do you know if there is any way to have a variable that is defined at
build time to populate the 'url' parameter in the qdocconf file?

Cheers,
David.

It depends on how the build knows what it targets. The qddocconf file could be modified at build time. But as far as I know PPA builds are the same as what goes into the archive.

This bug was fixed in the package ubuntu-ui-toolkit - 0.1.46daily13.06.05.1-0ubuntu1

---------------
ubuntu-ui-toolkit (0.1.46daily13.06.05.1-0ubuntu1) saucy; urgency=low

  [ Zoltán Balogh ]
  * update the example app for the latest UI Toolkit.
  * A simple app to check few locales.
  * Add qttools5-dev-tools to build dependencies to provide
    qhelpgenerator for creating QtC help files from documentation.
  * Build documentation and publish the qch file.
  * Offer symlinks for qmlscene via 'qmlrunner' package. See package
    description for usage instructions. (LP: #1155634). (LP: #1155634)

  [ Loïc Molinari ]
  * [UbuntuShape] Correctly stored the current material. (LP: #1132771)
  * [UbuntuShape] Ensured the texture is available in updatePaintNode().
    (LP: #1171437)

  [ Kaleo ]
  * QML_IMPORT_PATH is deprecated for QtQuick 2.0. Switch to
    QML2_IMPORT_PATH.
  * Added syntax description for CHANGES file in CHANGES.syntax.
  * UCScalingImageProvider: respect 'requestedSize' parameter. That
    ensures that the 'sourceSize' property of Image is respected even
    when the toolkit automatically scales the asset for the device. (LP:
    #1130120)
  * Added documentation for bitmap suffixes in the resolution
    independence page. (LP: #1092051)
  * Revamped component showcase now called 'Ubuntu UI Toolkit Gallery'.
    Works on Ubuntu Touch. (LP: #1130603)
  * Benchmarks for time critical components.
  * Added ListItem.ValueSelector example. Fixed incorrect 'Multi value'
    label. (LP: #1172663)
  * Toolkit Gallery: added examples for Sheets.
  * Automatic rotation of applications depending on the device
    orientation. For applications that are using MainView, they opt-in
    by setting 'automaticOrientation' to true. New component
    OrientationHelper for applications that do not use MainView but
    still need an easy way to automatically rotate.
  * UbuntuShape: fix slight distortion of image when set. This
    distortion was quite disturbing when the content has text in it, as
    it is often the case in Popups and Popovers. (LP: #1170878)
  * Use standard animation ubuntu snap beat for popups fade in.
  * Removed unnecessary clipping from Tabs, Popover, Dialog and
    MainView.
  * All ListItems: set default contents right and left margins to 2 gu.
    ListItems Base, Standard and ValueSelector: deprecated private
    properties __leftIconMargin and __rightIconMargin IconVisual
    (private): removed properties leftIconMargin and rightIconMargin
    Standard: removed ugly progression highlight background when there
    is no split.
  * ListItems: constrain size of the icon by default. Deprecated private
    properties __iconWidth and __iconHeight.
  * Ubuntu UI Toolkit Gallery tweaks: - Made window wider and left
    column the width of the phone: 40gu. - Removed 'slider.' from Slider
    example's labels. - Renamed 'Switches' into 'Toggles'. Renamed
    'Progress Bars' into 'Progress and activity'. - Use resolution
    independence for navigation example screenshots.
  * Support source with quotes in .sci files. (LP: #1080719)
  * Reverted unjustified changes to ubuntu-ui-toolkit-gallery.desktop.
  * Popover: simplified com...

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".