Skip to content

Commit

Permalink
[docs] Fix building documentation with Qt 5.6. Contribute to JB#37839
Browse files Browse the repository at this point in the history
Issues fixed:

- Error loading index page
    - Split out documentation for the QML module so that the index page
      is named "index.html".
- Examples page not listed in the TOC
    - Before it was automatically listed in the TOC. Fix this by adding
      a QHP subproject of type manual. This way also the next issue is
      fixed.
- Examples page not reachable where TOC is not available
    - Link the examples page from the index page.
- QML types not listed in TOC
    - Before these were automatically listed in the TOC. Add a QHP
      subproject to list them under.
  • Loading branch information
martyone committed Mar 13, 2017
1 parent 6270bfe commit f275ead
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 2 deletions.
8 changes: 8 additions & 0 deletions doc/nemo-qml-plugin-dbus.qdocconf
Expand Up @@ -16,6 +16,14 @@ qhp.NemoQmlPluginDBus.indexRoot =

qhp.NemoQmlPluginDBus.filterAttributes = nemo-qml-plugin-dbus 2.0

qhp.NemoQmlPluginDBus.subprojects = manual qmltypes
qhp.NemoQmlPluginDBus.subprojects.manual.type = manual
qhp.NemoQmlPluginDBus.subprojects.manual.indexTitle = Nemo QML Plugin D-Bus
qhp.NemoQmlPluginDBus.subprojects.qmltypes.title = QML Types
qhp.NemoQmlPluginDBus.subprojects.qmltypes.indexTitle = Nemo.DBus QML Types
qhp.NemoQmlPluginDBus.subprojects.qmltypes.selectors = qmlclass
qhp.NemoQmlPluginDBus.subprojects.qmltypes.sortPages = true

HTML.footer += \
"<div class=\"footer\">\n" \
" <p><acronym title=\"Copyright\">&copy;</acronym> 2015 Jolla OY</p>\n" \
Expand Down
2 changes: 1 addition & 1 deletion doc/src/examples.qdoc
@@ -1,6 +1,6 @@
/*!
\title Examples
\page examples.html examples
\page examples.html example

There are a number of examples which demonstrate how to use various aspects of the API.

Expand Down
19 changes: 18 additions & 1 deletion doc/src/index.qdoc
@@ -1,6 +1,13 @@
/*!
\qmlmodule Nemo.DBus 2.0
\contentspage
\title Nemo.DBus QML Types

This module includes the following types:

*/

/*!
\page index.html
\title Nemo QML Plugin D-Bus
\brief Provides types to access D-Bus from QML

Expand All @@ -27,4 +34,14 @@ on demand when their services are needed. (from the

This module includes the following types:

\generatelist{qmltypesbymodule Nemo.DBus}

\section2 Further Reading

\list

\li \l{Examples}

\endlist

*/

0 comments on commit f275ead

Please sign in to comment.