diff options
author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-04-27 14:32:54 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-04-28 06:50:13 +0000 |
commit | d9411d7c369487be5547956ef6c0224a2a4c9902 (patch) | |
tree | 34d2e7253133ede7417d96601995534b3950cd66 /doc | |
parent | b29368d2ed1172d80348153e75b8804efa208530 (diff) |
Doc: update doc configuration
- Add a sidebar to online docs
- include files from qt5/qtbase/docs/global and remove
unnecessary includes and files
- remove macros that are defined in the global macro file
Change-Id: If7e8d933fa9765b77a682a1eef770f9b95b513eb
Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/config/macros.qdocconf | 39 | ||||
-rw-r--r-- | doc/config/qbs-project.qdocconf | 7 | ||||
-rw-r--r-- | doc/config/qt-cpp-ignore.qdocconf | 99 | ||||
-rw-r--r-- | doc/config/qt-html-default-styles.qdocconf | 41 | ||||
-rw-r--r-- | doc/config/qt-html-templates.qdocconf | 64 | ||||
-rw-r--r-- | doc/config/style/qt5-sidebar.html | 13 | ||||
-rw-r--r-- | doc/qbs-online.qdocconf | 3 |
7 files changed, 21 insertions, 245 deletions
diff --git a/doc/config/macros.qdocconf b/doc/config/macros.qdocconf index 5d7a9665b..57ff72747 100644 --- a/doc/config/macros.qdocconf +++ b/doc/config/macros.qdocconf @@ -1,41 +1,2 @@ -macro.aacute.HTML = "á" -macro.Aring.HTML = "Å" -macro.aring.HTML = "å" -macro.Auml.HTML = "Ä" -macro.author = "\\bold{Author:}" -macro.br.HTML = "<br />" -macro.BR.HTML = "<br />" -macro.copyright.HTML = "©" -macro.eacute.HTML = "é" -macro.gui = "\\bold" -macro.hr.HTML = "<hr />" -macro.iacute.HTML = "í" -macro.key = "\\bold" -macro.menu = "\\bold" -macro.note = "\\bold{Note:}" -macro.oslash.HTML = "ø" -macro.ouml.HTML = "ö" -macro.QA = "\\e{Qt Assistant}" -macro.QD = "\\e{Qt Designer}" -macro.QL = "\\e{Qt Linguist}" -macro.QMLD = "\\e{Qt Quick Designer}" -macro.QQV = "\\e{Qt QML Viewer}" -macro.QSDK = "\\e{Qt SDK}" macro.QBS = "Qbs" macro.qbsversion = $QBS_VERSION -macro.param = "\\e" -macro.raisedaster.HTML = "<sup>*</sup>" -macro.rarrow.HTML = "→" -macro.reg.HTML = "<sup>®</sup>" -macro.return = "Returns" -macro.starslash = "\\c{*/}" -macro.begincomment = "\\c{/*}" -macro.endcomment = "\\c{*/}" -macro.uuml.HTML = "ü" -macro.mdash.HTML = "—" - -macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">" -macro.beginfloatright.HTML = "<div style=\"float: right; margin-left: 2em\">" -macro.endfloat.HTML = "</div>" -macro.clearfloat.HTML = "<br style=\"clear: both\" />" -macro.emptyspan.HTML = "<span></span>" diff --git a/doc/config/qbs-project.qdocconf b/doc/config/qbs-project.qdocconf index 22e9ba7f3..cc27432fe 100644 --- a/doc/config/qbs-project.qdocconf +++ b/doc/config/qbs-project.qdocconf @@ -1,3 +1,8 @@ +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) + project = "Qt Build Suite" description = "QBS Manual" @@ -8,8 +13,6 @@ outputdir = $OUTDIR exampledirs = $SRCDIR include(macros.qdocconf) -include(qt-cpp-ignore.qdocconf) - sources.fileextensions = "*.qdoc" diff --git a/doc/config/qt-cpp-ignore.qdocconf b/doc/config/qt-cpp-ignore.qdocconf deleted file mode 100644 index ce8de2406..000000000 --- a/doc/config/qt-cpp-ignore.qdocconf +++ /dev/null @@ -1,99 +0,0 @@ -Cpp.ignoretokens = QAXFACTORY_EXPORT \ - QDESIGNER_COMPONENTS_LIBRARY \ - QDESIGNER_EXTENSION_LIBRARY \ - QDESIGNER_SDK_LIBRARY \ - QDESIGNER_SHARED_LIBRARY \ - QDESIGNER_UILIB_LIBRARY \ - QM_EXPORT_CANVAS \ - QM_EXPORT_DNS \ - QM_EXPORT_DOM \ - QM_EXPORT_FTP \ - QM_EXPORT_HTTP \ - QM_EXPORT_ICONVIEW \ - QM_EXPORT_NETWORK \ - QM_EXPORT_OPENGL \ - QM_EXPORT_OPENVG \ - QM_EXPORT_SQL \ - QM_EXPORT_TABLE \ - QM_EXPORT_WORKSPACE \ - QM_EXPORT_XML \ - QT_ASCII_CAST_WARN \ - QT_ASCII_CAST_WARN_CONSTRUCTOR \ - QT_BEGIN_HEADER \ - QT_DESIGNER_STATIC \ - QT_END_HEADER \ - QT_FASTCALL \ - QT_WIDGET_PLUGIN_EXPORT \ - Q_COMPAT_EXPORT \ - Q_CORE_EXPORT \ - Q_CORE_EXPORT_INLINE \ - Q_EXPLICIT \ - Q_EXPORT \ - Q_EXPORT_CODECS_CN \ - Q_EXPORT_CODECS_JP \ - Q_EXPORT_CODECS_KR \ - Q_EXPORT_PLUGIN \ - Q_GFX_INLINE \ - Q_AUTOTEST_EXPORT \ - Q_GUI_EXPORT \ - Q_GUI_EXPORT_INLINE \ - Q_GUI_EXPORT_STYLE_CDE \ - Q_GUI_EXPORT_STYLE_COMPACT \ - Q_GUI_EXPORT_STYLE_MAC \ - Q_GUI_EXPORT_STYLE_MOTIF \ - Q_GUI_EXPORT_STYLE_MOTIFPLUS \ - Q_GUI_EXPORT_STYLE_PLATINUM \ - Q_GUI_EXPORT_STYLE_POCKETPC \ - Q_GUI_EXPORT_STYLE_SGI \ - Q_GUI_EXPORT_STYLE_WINDOWS \ - Q_GUI_EXPORT_STYLE_WINDOWSXP \ - QHELP_EXPORT \ - Q_INLINE_TEMPLATE \ - Q_INTERNAL_WIN_NO_THROW \ - Q_NETWORK_EXPORT \ - Q_OPENGL_EXPORT \ - Q_OPENVG_EXPORT \ - Q_OUTOFLINE_TEMPLATE \ - Q_SQL_EXPORT \ - Q_SVG_EXPORT \ - Q_SCRIPT_EXPORT \ - Q_SCRIPTTOOLS_EXPORT \ - Q_TESTLIB_EXPORT \ - Q_TYPENAME \ - Q_XML_EXPORT \ - Q_XMLSTREAM_EXPORT \ - Q_XMLPATTERNS_EXPORT \ - QDBUS_EXPORT \ - Q_DBUS_EXPORT \ - QT_BEGIN_NAMESPACE \ - QT_BEGIN_INCLUDE_NAMESPACE \ - QT_END_NAMESPACE \ - QT_END_INCLUDE_NAMESPACE \ - PHONON_EXPORT \ - Q_DECLARATIVE_EXPORT \ - Q_GADGET \ - QWEBKIT_EXPORT \ - Q_INVOKABLE \ - EXTENSIONSYSTEM_EXPORT -Cpp.ignoredirectives = Q_DECLARE_HANDLE \ - Q_DECLARE_INTERFACE \ - Q_DECLARE_METATYPE \ - Q_DECLARE_OPERATORS_FOR_FLAGS \ - Q_DECLARE_PRIVATE \ - Q_DECLARE_PUBLIC \ - Q_DECLARE_SHARED \ - Q_DECLARE_TR_FUNCTIONS \ - Q_DECLARE_TYPEINFO \ - Q_DISABLE_COPY \ - QT_FORWARD_DECLARE_CLASS \ - Q_DUMMY_COMPARISON_OPERATOR \ - Q_ENUMS \ - Q_FLAGS \ - Q_INTERFACES \ - __attribute__ \ - K_DECLARE_PRIVATE \ - PHONON_OBJECT \ - PHONON_HEIR \ - Q_PRIVATE_PROPERTY \ - Q_DECLARE_PRIVATE_D \ - Q_CLASSINFO diff --git a/doc/config/qt-html-default-styles.qdocconf b/doc/config/qt-html-default-styles.qdocconf deleted file mode 100644 index a2a918bd6..000000000 --- a/doc/config/qt-html-default-styles.qdocconf +++ /dev/null @@ -1,41 +0,0 @@ -# Define the location of the templates to use. Style sheets and scripts are -# specified relative to the template directory and will be copied into -# subdirectories of the output directory. - -HTML.templatedir = $SRCDIR/templates - -HTML.stylesheets = style/offline.css - -HTML.scripts = - -# Files not referenced in any qdoc file (last four needed by qtdemo) -# See also qhp.Qt.extraFiles -extraimages.HTML = qt-logo.png \ - arrow_down.png \ - breadcrumb.png \ - bullet_gt.png \ - bullet_dn.png \ - bullet_sq.png \ - bullet_up.png \ - horBar.png \ - sprites-combined.png \ - bgrContent.png \ - blu_dot.png \ - btn_next.png \ - btn_prev.png \ - ico_note.png \ - ico_note_attention.png \ - ico_out.png \ - arrow.png \ - home.png - -# Include the style sheets and scripts used. - -HTML.headerstyles = \ - " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/offline.css\" />\n" - -HTML.headerscripts = - -HTML.endheader = \ - "</head>\n" \ - "<body>\n" diff --git a/doc/config/qt-html-templates.qdocconf b/doc/config/qt-html-templates.qdocconf deleted file mode 100644 index 9d82754f4..000000000 --- a/doc/config/qt-html-templates.qdocconf +++ /dev/null @@ -1,64 +0,0 @@ -include(qt-html-default-styles.qdocconf) - -HTML.postheader = \ - "<div class=\"header\" id=\"qtdocheader\">\n" \ - " <div class=\"content\"> \n" \ - " <a href=\"index.html\" class=\"qtref\"><span>Qbs Documentation</span></a>\n" \ - " </div>\n" \ - " <div class=\"breadcrumb\">\n" \ - " <ul>\n" \ - " <li class=\"first\"><a href=\"index.html\">Home</a></li>\n" \ - " <!-- Breadcrumbs go here -->\n" - -HTML.postpostheader = \ - "\n" \ - " </ul>\n" \ - " </div>\n" \ - "</div>\n" \ - "<div class=\"content mainContent\">\n" - -HTML.footer = \ - " <div class=\"ft\">\n" \ - " <span></span>\n" \ - " </div>\n" \ - "</div> \n" \ - "<div class=\"footer\">\n" \ - " <p>\n" \ - " <acronym title=\"Copyright\">©</acronym> 2008-2015 The Qt Company Ltd.\n" \ - " Qt and respective logos are trademarks of The Qt Company Ltd\n" \ - " in Finland and/or other countries worldwide.</p>\n" \ - " <p>\n" \ - " All other trademarks are property of their respective owners. <a title=\"Privacy Policy\"\n" \ - " href=\"http://en.gitorious.org/privacy_policy/\">Privacy Policy</a></p>\n" \ - " <br />\n" \ - " <p>\n" \ - " Licensees holding valid Qt Commercial licenses may use this document in accordance with the" \ - " Qt 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.</p>\n" \ - " <p>\n" \ - " Alternatively, this document may be used under the terms of the <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU\n" \ - " Free Documentation License version 1.3</a>\n" \ - " as published by the Free Software Foundation.</p>\n" \ - "</div>\n" \ - -# Files not referenced in any qdoc file. -# See also extraimages.HTML -qhp.QtCreator.extraFiles = index.html \ - images/arrow_down.png \ - images/breadcrumb.png \ - images/bullet_gt.png \ - images/bullet_dn.png \ - images/bullet_sq.png \ - images/bullet_up.png \ - images/horBar.png \ - images/sprites-combined.png \ - images/bgrContent.png \ - images/blu_dot.png \ - images/btn_next.png \ - images/btn_prev.png \ - images/ico_note.png \ - images/ico_note_attention.png \ - images/ico_out.png \ - images/home.png \ - images/arrow.png \ - style/offline.css diff --git a/doc/config/style/qt5-sidebar.html b/doc/config/style/qt5-sidebar.html new file mode 100644 index 000000000..fb15b30f3 --- /dev/null +++ b/doc/config/style/qt5-sidebar.html @@ -0,0 +1,13 @@ +<div class="sectionlist normallist"> + <div class="heading"> + <a name="reference"></a> + <h2 id="reference">Qbs Manual</h2> + </div> + <div class="indexboxcont indexboxbar"> + <ul> + <li><a href="overview.html">Introduction</a></li> + <li><a href="setup.html">Setup</a></li> + <li><a href="usage.html">Usage</a></li> + <li><a href="reference.html">Reference</a></li> + </ul> + </div> diff --git a/doc/qbs-online.qdocconf b/doc/qbs-online.qdocconf index 4c21d1e8e..137fae73a 100644 --- a/doc/qbs-online.qdocconf +++ b/doc/qbs-online.qdocconf @@ -14,3 +14,6 @@ HTML.footer = \ " 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 |