Merge lp:~kalikiana/ubuntu-ui-toolkit/online into lp:ubuntu-ui-toolkit

[Cris Dywan]

Use offline documentation as a basis for online docs

Use offline documentation as a basis for online docs

[David Planella (dpm)]

Thanks Christian. However, I'm a bit confused by this change. Two things:

- The request on bug 1183013 was to do exactly the opposite: use the online configuration to generate the docs, yet this MP does not change the current situation.
- Why include ubuntu-ui-toolkit-offline.qdocconf in the file if it can be called by itself? If the intention is to use the offline configuration, it might make more sense just to remove the online conf file.

review: Needs Fixing

[Cris Dywan (kalikiana)]

You seem to misread the diff: The offline config actually contains the proper header and footer, while the online config contains online font files and duplicates the stylesheets.

So I'm stopping needless duplication, and the only online piece here is the fonts.

review: Needs Resubmitting

[Cris Dywan (kalikiana)]

review: Abstain

[Cris Dywan (kalikiana)]

Something is fishy, though. I'm not sure the tooling is matching my understanding of the config file.

review: Needs Fixing

[Cris Dywan (kalikiana)]

Correction: the config works, but 'make docs' is broken, so only now I see that it produces broken styling.

[David Planella (dpm)]

Ok, gotcha. The way the configuration works right now is the following:

online offline
  | |
  +---+----+
      |
    common

So both the online and offline config files include the common config, and you can switch between the two. The bug was not about changing the config files, but rather about the ubuntu-ui-toolkit-doc package to call the online conf during build instead of the offline one.

Although I agree it makes sense to improve the config if it can be in a better way.

After looking at it again, I understand that what the change is doing is the following:

offline
  |
  +-- online
        |
      common

If that works, then perfect :)

[Cris Dywan (kalikiana)]

The bug is "use online docs" which literally speaking is already true which leaves me to figure out what the real problem in the build system is.

I'm getting a more complete understanding what is wrong and will attempt to turn 3 bad ways to generate docs into 1 working way now.

[lp:~kalikiana/ubuntu-ui-toolkit/online]

517. By Cris Dywan on 2013-05-27

Remove target-less qdoc commands and separate html script

[Cris Dywan (kalikiana)]

review: Approve

[David Planella (dpm)]

Looks good to me, generated docs too, although I got some warnings:

http://pastebin.ubuntu.com/5706410/

review: Approve

[Cris Dywan (kalikiana)]

As discussed on IRC the warnings are not new, only more visible.

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'documentation/documentation.pri'
--- documentation/documentation.pri	2013-05-05 18:10:47 +0000
+++ documentation/documentation.pri	2013-05-27 10:31:29 +0000
@@ -1,8 +1,3 @@
-QDOC = /usr/lib/*/qt5/bin/qdoc
-system($$QDOC $$PWD/ubuntu-ui-toolkit-online.qdocconf)
-system($$QDOC $$PWD/ubuntu-ui-toolkit-qtcreator.qdocconf)
-system(qhelpgenerator -o "$$PWD/html/ubuntuuserinterfacetoolkit.qch" "$$PWD/html/ubuntuuserinterfacetoolkit.qhp")
-
 install_docs.files = $$PWD/html
 install_docs.path = /usr/share/ubuntu-ui-toolkit/doc
 

=== removed file 'documentation/generate_html.sh'
--- documentation/generate_html.sh	2013-04-09 16:16:35 +0000
+++ documentation/generate_html.sh	1970-01-01 00:00:00 +0000
@@ -1,23 +0,0 @@
-#!/bin/sh
-#
-# Copyright 2012 Canonical Ltd.
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation; version 3.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-QDOCCONF_FILE=ubuntu-ui-toolkit-online.qdocconf
-QDOC_BIN=/usr/lib/*/qt5/bin/qdoc
-
-sed "s|documentation/||" < $QDOCCONF_FILE > $QDOCCONF_FILE.tmp
-$QDOC_BIN $QDOCCONF_FILE.tmp
-rm $QDOCCONF_FILE.tmp

=== modified file 'documentation/ubuntu-ui-toolkit-online.qdocconf'
--- documentation/ubuntu-ui-toolkit-online.qdocconf	2013-04-09 16:16:35 +0000
+++ documentation/ubuntu-ui-toolkit-online.qdocconf	2013-05-27 10:31:29 +0000
@@ -1,13 +1,7 @@
-include(ubuntu-ui-toolkit-common.qdocconf)
+include(ubuntu-ui-toolkit-offline.qdocconf)
 include(ubuntu-appdev-site-header.qdocconf)
 include(ubuntu-appdev-site-footer.qdocconf)
 
-HTML.stylesheets = \
-    documentation/css/reset.css \
-    documentation/css/qtquick.css \
-    documentation/css/base.css \
-    documentation/css/scratch.css
-
 HTML.headerstyles = \
   "<link rel=\"stylesheet\" type=\"text/css\" href=\"http://fonts.googleapis.com/css?family=Ubuntu:400,400italic\">\n" \
   "<link rel=\"stylesheet\" type=\"text/css\" href=\"http://fonts.googleapis.com/css?family=Ubuntu+Mono:400\">\n" \

=== modified file 'ubuntu-sdk.pro'
--- ubuntu-sdk.pro	2013-05-21 18:25:58 +0000
+++ ubuntu-sdk.pro	2013-05-27 10:31:29 +0000
@@ -19,6 +19,7 @@
 DOC_PATH=${PWD}/documentation
 docs.target = docs
 docs.commands += qdoc $$DOC_PATH/ubuntu-ui-toolkit-qtcreator.qdocconf;
-docs.commands += qhelpgenerator -o "$$DOC_PATH/html/ubuntuuserinterfacetoolkit.qch" "$$DOC_PATH/html/ubuntuuserinterfacetoolkit.qhp"
+docs.commands += qhelpgenerator -o "$$DOC_PATH/html/ubuntuuserinterfacetoolkit.qch" "$$DOC_PATH/html/ubuntuuserinterfacetoolkit.qhp";
+docs.commands += qdoc $$DOC_PATH/ubuntu-ui-toolkit-online.qdocconf;
 QMAKE_EXTRA_TARGETS += docs