Fix issues related to documentation configuration5.7

    - Add an online sidebar with quick links
    - Fix namespacing for html filenames
    - Remove classes.qdoc (contained class listings from Qt,
      and was not linked to from qmllive docs).
    - Fix output directory in online doc builds
    - Replace navigation.landingpage with homepage, so
      this doesn't appear as a submodule of Qt 5.7
    - Fix doc project name, documentation base url

Change-Id: I0105f2d7e866b1d044ce52a952f25a1647954929
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>

8 files changed, 25 insertions, 109 deletions

diff --git a/doc/classes.qdoc b/doc/classes.qdoc
deleted file mode 100644
index 952f2d9..0000000
--- a/doc/classes.qdoc
+++ /dev/null
@@ -1,100 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2016 Pelagicore AG
-** Contact: https://www.qt.io/licensing/
-**
-** This file is part of the QmlLive tool.
-**
-** $QT_BEGIN_LICENSE:GPL-QTAS$
-** Commercial License Usage
-** Licensees holding valid commercial Qt Automotive Suite licenses may use
-** this file in accordance with the commercial license agreement provided
-** with the Software or, alternatively, in accordance with the terms
-** contained in a written agreement between you and The Qt Company.  For
-** licensing terms and conditions see https://www.qt.io/terms-conditions.
-** For further information use the contact form at https://www.qt.io/contact-us.
-**
-** GNU General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU
-** General Public License version 3 or (at your option) any later version
-** approved by the KDE Free Qt Foundation. The licenses are as published by
-** the Free Software Foundation and appearing in the file LICENSE.GPL3
-** included in the packaging of this file. Please review the following
-** information to ensure the GNU General Public License requirements will
-** be met: https://www.gnu.org/licenses/gpl-3.0.html.
-**
-** $QT_END_LICENSE$
-**
-** SPDX-License-Identifier: GPL-3.0
-**
-****************************************************************************/
-
-/*!
-    \group classlists
-    \title Class and Function Documentation
-    \brief Lists and Indexes of classes, functions, and types.
-
-    Links to indexes and lists for finding class and function
-    reference documentation.
-
-    \section2 Class Lists
-
-    \annotatedlist classlists
-
-    \section2 Function Lists
-
-    \annotatedlist funclists
-
-*/
-
-/*!
-    \page classes.html
-    \title All Classes
-    \ingroup classlists
-
-    \brief If you know the name of the class you want, find it here.
-
-    This is a list of all Qt classes.
-
-    \generatelist classes
-*/
-
-/*!
-    \page hierarchy.html
-
-    \title Inheritance Hierarchy
-    \ingroup classlists
-
-    \brief The C++ class inheritance hierarchy for all classes in the
-    Qt API.
-
-    \generatelist classhierarchy
-*/
-
-/*!
-    \page functions.html
-    \title All Functions
-    \ingroup funclists
-
-    \brief All documented Qt functions listed alphabetically with a
-    link to their declarations.
-
-    This is the list of all documented member functions and global
-    functions in the Qt API.  Each function has a link to the class or
-    header file where it is declared and documented.
-
-    \generatelist functionindex
-*/
-
-
-/*!
-    \page namespaces.html
-    \title All Namespaces
-    \ingroup classlists
-
-    \brief A Qt namespace contains enum types, functions, and sometimes classes.
-
-    This is a list of the main namespaces in Qt.
-
-    \generatelist{namespaces}
-*/
diff --git a/doc/concepts.qdoc b/doc/concepts.qdoc
index 527c696..4e074b6 100644
--- a/doc/concepts.qdoc
+++ b/doc/concepts.qdoc
@@ -31,7 +31,7 @@
 
 /*!
 
-\page concepts.html
+\page qmllive-concepts.html
 \title Concepts
 
 \chapter Live Reloading
diff --git a/doc/index.qdoc b/doc/index.qdoc
index 90eecb3..a2b44a9 100644
--- a/doc/index.qdoc
+++ b/doc/index.qdoc
@@ -31,7 +31,7 @@
 
 /*!
 
-\page index.html
+\page qmllive-index.html
 \keyword Pelagicore QML Live Reference Documentation
 \indexpage
 \title Qt QML Live
diff --git a/doc/installation.qdoc b/doc/installation.qdoc
index bed44d8..b36de83 100644
--- a/doc/installation.qdoc
+++ b/doc/installation.qdoc
@@ -31,7 +31,7 @@
 
 /*!
 
-\page installation.html
+\page qmllive-installation.html
 \title Installation
 
 \chapter Dependencies
diff --git a/doc/qmllive-online.qdocconf b/doc/qmllive-online.qdocconf
index 09b46fe..087139e 100644
--- a/doc/qmllive-online.qdocconf
+++ b/doc/qmllive-online.qdocconf
@@ -15,6 +15,9 @@ HTML.footer = \
 include($QT_INSTALL_DOCS/global/qt-html-templates-online.qdocconf)
 
 # Add an .html file with sidebar content, used in the online style
-# HTML.stylesheets               += style/qt5-sidebar.html
+HTML.stylesheets               += style/qt5-sidebar.html
+
+HTML.nosubdirs = "false"
+HTML.outputsubdir = "qmllive"
 
 include(qmllive-project.qdocconf)
diff --git a/doc/qmllive-project.qdocconf b/doc/qmllive-project.qdocconf
index d93882b..241a629 100644
--- a/doc/qmllive-project.qdocconf
+++ b/doc/qmllive-project.qdocconf
@@ -1,6 +1,6 @@
-project = QML Live
+project = QmlLive
 description = Pelagicore QML Live Reference Documentation
-url = https://doc.qt.io/QmlLive
+url = https://doc.qt.io/QtQmlLive
 version = $QT_VERSION
 
 sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
@@ -14,7 +14,7 @@ exampledirs = ../examples ../src
 headerdirs = \
     ../src
 
-sourcedirs = \
+sourcedirs += \
     . \
     ../src \
     ../examples
@@ -37,5 +37,5 @@ qhp.QmlLive.subprojects.manual.title = Qt QML Live
 qhp.QmlLive.subprojects.manual.indexTitle = Qt QML Live
 qhp.QmlLive.subprojects.manual.type = manual
 
-navigation.landingpage = "Qt QML Live"
+navigation.homepage = "Qt QML Live"
 buildversion = "Qt QML Live $QT_VERSION"
diff --git a/doc/style/qt5-sidebar.html b/doc/style/qt5-sidebar.html
new file mode 100644
index 0000000..7b6ce39
--- /dev/null
+++ b/doc/style/qt5-sidebar.html
@@ -0,0 +1,13 @@
+<div class="sectionlist normallist">
+    <div class="heading">
+        <h2>Qt QML Live</h2>
+    </div>
+    <ul>
+        <li><a href="index.html">Home</a></li>
+        <li><a href="qmllive-installation.html">Installation</a></li>
+        <li><a href="qmllive-usage.html">Usage</a></li>
+        <li><a href="qmllive-concepts.html">Concepts</a></li>
+        <li><a href="qmllive-reference.html">Reference</a></li>
+        <li><a href="qmllive-examples.html">Examples</a></li>
+    </ul>
+</div>
diff --git a/doc/usage.qdoc b/doc/usage.qdoc
index ed67e4a..600c157 100644
--- a/doc/usage.qdoc
+++ b/doc/usage.qdoc
@@ -31,7 +31,7 @@
 
 /*!
 
-\page usage.html
+\page qmllive-usage.html
 \title Usage
 
 \chapter Introduction