summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@digia.com>2015-01-29 10:29:46 +0100
committerLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2015-01-29 13:15:59 +0000
commit110392ad183466c746550720fc72eef45d248010 (patch)
treef63a3428f3a24bd089f2c0e84d2c127a342aeff4
parent4780f0edbfd6b26977c4ae65b449a4be9842cc40 (diff)
downloadqt-creator-110392ad183466c746550720fc72eef45d248010.tar.gz
Doc: fix bug in doc building instructions
And add a note about the new online style. Change-Id: I4d16ea45dd121a27c5c8d8c0fe5e5b971f8c2d05 Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com>
-rw-r--r--doc/api/qtcreator-documentation.qdoc9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/api/qtcreator-documentation.qdoc b/doc/api/qtcreator-documentation.qdoc
index 2ec78a2c4d..32cb491f58 100644
--- a/doc/api/qtcreator-documentation.qdoc
+++ b/doc/api/qtcreator-documentation.qdoc
@@ -258,7 +258,7 @@
changed over time, so they differ between Qt and \QC versions. Since \QC
version 3.3, only Qt 5 is supported for building documentation. The
templates to use are defined by the
- \c qt5\qtbase\doc\global\qt-html-templates-offline.qdocconf} and
+ \c {qt5\qtbase\doc\global\qt-html-templates-offline.qdocconf} and
\c {qt5\qtbase\doc\global\qt-html-templates-online.qdocconf} configuration
file. They are fetched from Qt sources by adding the following lines to the
qdocconf file:
@@ -266,11 +266,14 @@
\list
\li \c {include ($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)}
- for publishing on the web
- \li \c {include ($QT_INSTALL_DOCS/global/qt-html-templates-online.qdocconf)}
for help files
+ \li \c {include ($QT_INSTALL_DOCS/global/qt-html-templates-online.qdocconf)}
+ for publishing on the web
\endlist
+ \note To have the correct fonts loaded for the online version, you must be
+ running it on a web server.
+
\note If the styles look wrong to you when reading help files in \QC or \QA,
you might be looking at them in the QTextBrowser instead of the WebKit
browser. This happens if you build \QC and \QA with a self-built Qt and did