From a436ffc0b9b7deedf9d18500baf7be5e01a4c97b Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@digia.com>
Date: Thu, 28 Feb 2013 15:39:50 +0100
Subject: [PATCH] Doc: update info about building the docs
Change-Id: I80de9d6b13e286f9eb95efc69b5b4b5256541f2f
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
---
doc/api/qtcreator-documentation.qdoc | 30 +++++++++++++---------------
1 file changed, 14 insertions(+), 16 deletions(-)
diff --git a/doc/api/qtcreator-documentation.qdoc b/doc/api/qtcreator-documentation.qdoc
index 5fff327bd28..90fdcda6b79 100644
--- a/doc/api/qtcreator-documentation.qdoc
+++ b/doc/api/qtcreator-documentation.qdoc
@@ -255,28 +255,33 @@
troubleshooting.
The content and formatting of documentation are separated in QDoc.
- Separate style sheets are used to generate help files for \QC and online
+ The documentation configuration, style sheets, and templates have
+ changed over time, so they differ between Qt and \QC versions. In Qt 4,
+ separate style sheets are used to generate help files for \QC and online
documentation for the Web.
- The documentation configuration, style sheets, and build process have
- changed over time, so they differ between Qt and \QC versions. To use the
- online style, use QDoc from Qt 4.7.4 to build the docs. To use the \QC help
- style, use QDoc from Qt 4.8, or later.
+ In Qt 5, only one set of templates is used, as defined by the
+ \c {qt5\qtbase\doc\global\qt-module-defaults.qdocconf} configuration file.
+ It is fetched from Qt sources by adding the following line to the qdocconf
+ file:
+
+ \c {include ($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)}
+
+ To pick the Qt to use, run qmake from either Qt 4 or Qt 5.
To build documentation for the sources from the qtcreator master branch, use
build scripts defined in the doc.pri file. To build all \QC docs in the
help format and to create help files (.qch), enter the following build
- commands from the project folder:
+ commands from the project folder (after running qmake):
\list
\o nmake docs (on Windows)
- \o make docs (on Linux)
+ \o make docs (on Linux and Mac OS)
\endlist
- The following options generate HTML that uses the help style, and therefore
- require QDoc from Qt 4.8 or later:
+ Besides \c docs, you have the following options:
\list
@@ -292,13 +297,6 @@
\o dev_qch_docs - build Extending \QC Manual in help format and
generate a help file (.qch)
- \endlist
-
- The following options generate HTML that uses the online style (they do not
- generate a help file), and therefore require QDoc from Qt 4.7.4:
-
- \list
-
\o docs_online - build \QC Manual and Extending \QC Manual in online
format
--
GitLab