summaryrefslogtreecommitdiffstats
path: root/doc/config
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2014-11-25 09:58:05 +0100
committerLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2014-11-26 14:18:06 +0100
commitd81176d2dd3b03cc6a2f9d69e1fd1e90832a0374 (patch)
tree8dc6ae4ca9c0c9023d7403d154341cd22fbae702 /doc/config
parentac79fa8edf9d81c801c120f3c9d9edf93d2b0bfe (diff)
Doc: prepare for Qt.io
Brought back the online and offline configuration files, because they will use different templates again. Added an HTML footer needed for other docs than Qt reference docs on Qt.io. Added an HTML file with sidebar content used in the online style. Change-Id: I2f806b955fe86618af64df40db414ba82d81092d Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'doc/config')
-rw-r--r--doc/config/ifw.qdocconf60
-rw-r--r--doc/config/style/qt5-sidebar.html17
2 files changed, 77 insertions, 0 deletions
diff --git a/doc/config/ifw.qdocconf b/doc/config/ifw.qdocconf
new file mode 100644
index 000000000..51b4993bb
--- /dev/null
+++ b/doc/config/ifw.qdocconf
@@ -0,0 +1,60 @@
+include($QT_INSTALL_DOCS/global/macros.qdocconf)
+include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf)
+include($QT_INSTALL_DOCS/global/compat.qdocconf)
+include($QT_INSTALL_DOCS/global/fileextensions.qdocconf)
+
+language = Cpp
+project = "Qt Installer Framework"
+description = "Qt Installer Framework Manual"
+url = http://qt-project.org/doc/qtinstallerframework/
+
+sourcedirs += includes
+sourcedirs += ../src/libs/installer ../src/libs/kdtools
+headerdirs += ../src/libs/installer ../src/libs/kdtools
+
+imagedirs = $SRCDIR/images $SRCDIR/templates/images
+outputdir = $OUTDIR
+exampledirs = $SRCDIR ../examples
+
+headers.fileextensions = "*.h"
+sources.fileextensions = "*.qdoc *.qdocinc *.cpp"
+examples.fileextensions = "*.js *.qs *.txt *.xml"
+examples.imageextensions = "*.png"
+
+indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \
+ $QT_INSTALL_DOCS/qtwidgets/qtwidgets.index \
+ $QT_INSTALL_DOCS/qtqml/qtqml.index \
+ $QT_INSTALL_DOCS/qtxml/qtxml.index \
+ $QT_INSTALL_DOCS/qtconcurrent/qtconcurrent.index \
+ $QT_INSTALL_DOCS/qtnetwork/qtnetwork.index
+
+qhp.projects = InstallerFramework
+qhp.InstallerFramework.file = ifw.qhp
+qhp.InstallerFramework.namespace = org.qt-project.ifw.$IFW_VERSION_TAG
+qhp.InstallerFramework.virtualFolder = doc
+qhp.InstallerFramework.indexTitle = Qt Installer Framework Manual
+qhp.InstallerFramework.filterAttributes = ifw
+qhp.InstallerFramework.customFilters.InstallerFramework.name = Installer Framework
+qhp.InstallerFramework.customFilters.InstallerFramework.filterAttributes = ifw
+qhp.InstallerFramework.indexRoot =
+
+qhp.InstallerFramework.subprojects = manual
+qhp.InstallerFramework.subprojects.manual.title = Qt Installer Framework Manual
+qhp.InstallerFramework.subprojects.manual.indexTitle = Qt Installer Framework Manual
+qhp.InstallerFramework.subprojects.manual.type = manual
+
+macro.ifwversion = $IFW_VERSION
+
+# Doxygen compatibility commands
+
+macro.see = "\\sa"
+macro.function = "\\fn"
+
+
+# We 'misuse' QML doc commands to generate JS documentation
+# (only works with qdoc from Qt 5)
+
+outputprefixes = QML
+outputprefixes.QML =
+
+navigation.homepage = "Qt Installer Framework Manual"
diff --git a/doc/config/style/qt5-sidebar.html b/doc/config/style/qt5-sidebar.html
new file mode 100644
index 000000000..f8782639d
--- /dev/null
+++ b/doc/config/style/qt5-sidebar.html
@@ -0,0 +1,17 @@
+<div class="sectionlist normallist">
+ <div class="heading">
+ <a name="reference"></a>
+ <h2 id="reference">Qt Installer Framework Manual</h2>
+ </div>
+ <div class="indexboxcont indexboxbar">
+ <ul>
+ <li><a href="ifw-overview.html">Overview of Qt Installer Framework</a></li>
+ <li><a href="ifw-getting-started.html">Getting Started</a></li>
+ <li><a href="ifw-use-cases.html">End User Workflows</a></li>
+ <li><a href="ifw-tutorial.html">Tutorial: Creating an Installer</a></li>
+ <li><a href="ifw-creating-installers.html">Creating Installers</a></li>
+ <li><a href="qtifwexamples.html">Qt Installer Framework Examples</a></li>
+ <li><a href="ifw-reference.html">Reference</a></li>
+ <li><a href="ifw-knownissues.html">Known Issues</a></li>
+ </ul>
+ </div>