mirror of
https://github.com/QuasarApp/installer-framework.git
synced 2025-05-07 18:49:34 +00:00
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>
This commit is contained in:
Leena Miettinen
parent
ac79fa8edf
commit
d81176d2dd
60
doc/config/ifw.qdocconf
Normal file
60
doc/config/ifw.qdocconf
Normal file
@ -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"
|
||||
17
doc/config/style/qt5-sidebar.html
Normal file
17
doc/config/style/qt5-sidebar.html
Normal file
@ -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>
|
||||
@ -27,7 +27,7 @@ QCH_FILE = $$OUT_PWD/doc/ifw.qch
|
||||
html_docs.commands = $$QDOC $$PWD/installerfw.qdocconf
|
||||
html_docs.files = $$QHP_FILE
|
||||
|
||||
html_docs_online.commands = $$QDOC $$PWD/installerfw.qdocconf
|
||||
html_docs_online.commands = $$QDOC $$PWD/installerfw-online.qdocconf
|
||||
html_docs_online.files = $$QHP_FILE
|
||||
|
||||
qch_docs.commands = $$HELPGENERATOR -o $$QCH_FILE $$QHP_FILE
|
||||
|
||||
20
doc/installerfw-online.qdocconf
Normal file
20
doc/installerfw-online.qdocconf
Normal file
@ -0,0 +1,20 @@
|
||||
# Run qdoc from the directory that contains this file.
|
||||
include(config/ifw.qdocconf)
|
||||
|
||||
HTML.footer = \
|
||||
" </div>\n" \
|
||||
" <p class=\"copy-notice\">\n" \
|
||||
" <acronym title=\"Copyright\">©</acronym> 2014 Digia Plc and/or its\n" \
|
||||
" subsidiaries. Documentation contributions included herein are the copyrights of\n" \
|
||||
" their respective owners. " \
|
||||
" The documentation provided herein is licensed under the terms of the" \
|
||||
" <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation" \
|
||||
" License version 1.3</a> as published by the Free Software Foundation. " \
|
||||
" Digia, Qt and their respective logos are trademarks of Digia Plc " \
|
||||
" in Finland and/or other countries worldwide. All other trademarks are property\n" \
|
||||
" of their respective owners. </p>\n"
|
||||
|
||||
include($QT_INSTALL_DOCS/global/qt-html-templates-online.qdocconf)
|
||||
|
||||
# Add an .html file with sidebar content, used in the online style
|
||||
HTML.stylesheets += config/style/qt5-sidebar.html
|
||||
@ -1,61 +1,3 @@
|
||||
# Run qdoc from the directory that contains this file.
|
||||
include(config/ifw.qdocconf)
|
||||
include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
|
||||
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"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user