aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEike Ziller <eike.ziller@qt.io>2017-03-10 15:36:12 +0100
committerEike Ziller <eike.ziller@qt.io>2017-03-10 15:38:01 +0100
commit0467aa5c9065c0dcc8636f79709316da1122e908 (patch)
tree359062bfff3fbee759d433792b315a137799f416
parent42c68ad7b51a809e25c8493c221a7ca730c9539d (diff)
parentef470a1d10c619f28614140d71e694253e8e6b47 (diff)
Merge remote-tracking branch 'origin/4.2' into 4.3
-rw-r--r--doc/api/qtcreator-documentation.qdoc29
-rw-r--r--doc/src/overview/creator-getting-started.qdoc2
-rw-r--r--docs.pri11
-rwxr-xr-xscripts/createDevPackage.py1
-rwxr-xr-xtests/system/suite_HELP/tst_HELP06/test.py4
5 files changed, 32 insertions, 15 deletions
diff --git a/doc/api/qtcreator-documentation.qdoc b/doc/api/qtcreator-documentation.qdoc
index 8b70832e241..8d53f03bbec 100644
--- a/doc/api/qtcreator-documentation.qdoc
+++ b/doc/api/qtcreator-documentation.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2016 The Qt Company Ltd.
+** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -68,8 +68,9 @@
QDoc finds the new topics automatically, when you place them as \c {.qdoc}
files in the correct folder. However, to make the topics accessible to
- readers, you must also add them to the table of contents and fix the next
- page and previous page links to them from other topics.
+ readers, you must also add them to the table of contents
+ (\c {doc\src\qtcreator-toc.qdoc}) and fix the next page and previous page
+ links to them from other topics.
\section2 Creating Folders and Files
@@ -110,9 +111,11 @@
commands to the topic, with dummy values (for example,
\c {\nextpage=anything.html}).
- \note The script creates the links according to the TOC on the front page.
- If your topics are not listed in the TOC, the script removes the
- \c {\nextpage} and \c {\previouspage} commands from them.
+ \note The script creates the links according to the TOC in the topic set as
+ the value of the \c indexTitle configuration parameter
+ (\c {doc\src\qtcreator-toc.qdoc}). If your topics are not listed in the TOC,
+ the script removes the \c {\nextpage} and \c {\previouspage} commands from
+ them.
To run the script, you must have Perl installed. If you build Qt yourself,
you should already have it. Otherwise, download and install
@@ -245,6 +248,11 @@
The error messages that QDoc issues are generally very useful for
troubleshooting.
+ For more information about setting up the build environment if you do not
+ want to build the whole Qt, see
+ \l{https://wiki.qt.io/Building_Qt_Documentation}{Building Qt Documentation}
+ on the Qt wiki.
+
The content and formatting of documentation are separated in QDoc.
The documentation configuration, style sheets, and templates have
changed over time, so they differ between Qt and \QC versions. Since \QC
@@ -266,9 +274,8 @@
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
- not build Qt WebKit.
+ you might be looking at them in the QTextBrowser instead of the Qr WebEngine
+ browser. This happens if you do not have Qt WebEngine installed.
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
@@ -281,9 +288,9 @@
\li make docs (on Linux and \macos)
\endlist
- The \QC Manual HTML files are generated in the \c {doc/html} directory.
+ The \QC Manual HTML files are generated in the \c {doc/qtcreator} directory.
The Extending \QC Manual files are generated in the
- \c {doc/html-dev} directory. The help files (\c {.qch}) are generated in the
+ \c {doc/qtcreator-dev} directory. The help files (\c {.qch}) are generated in the
\c {share/doc/qtcreator} directory in the \QC build directory on Windows and
Linux, and in the \c {bin/Qt Creator.app/Contents/Resources/app} directory
on \macos. You can view the HTML files in a browser and the help files in
diff --git a/doc/src/overview/creator-getting-started.qdoc b/doc/src/overview/creator-getting-started.qdoc
index 4d2956b4d2e..23f1027a84f 100644
--- a/doc/src/overview/creator-getting-started.qdoc
+++ b/doc/src/overview/creator-getting-started.qdoc
@@ -31,7 +31,7 @@
/*!
\contentspage {Qt Creator Manual}
- \previouspage {Qt Creator Manual}
+ \previouspage index.html
\page creator-getting-started.html
\nextpage creator-overview.html
diff --git a/docs.pri b/docs.pri
index 68c6d414500..4c125724a3f 100644
--- a/docs.pri
+++ b/docs.pri
@@ -28,12 +28,19 @@ for (qtc_doc, QTC_DOCS) {
QTC_DOCS_TARGETDIR = $$QTC_DOCS_TARGET
QTC_DOCS_OUTPUTDIR = $$QTC_DOCS_BASE_OUTDIR/$$QTC_DOCS_TARGETDIR
+ html_docs_$${QTC_DOCS_TARGET}.commands = $$QDOC -outputdir $$shell_quote($$QTC_DOCS_OUTPUTDIR) $$qtc_doc $$DOC_INDEXES
+ QMAKE_EXTRA_TARGETS += html_docs_$${QTC_DOCS_TARGET}
+
!isEmpty(html_docs.commands): html_docs.commands += &&
- html_docs.commands += $$QDOC -outputdir $$shell_quote($$QTC_DOCS_OUTPUTDIR) $$qtc_doc $$DOC_INDEXES
+ html_docs.commands += $$eval(html_docs_$${QTC_DOCS_TARGET}.commands)
!build_online_docs {
+ qch_docs_$${QTC_DOCS_TARGET}.commands = $$QHELPGENERATOR $$shell_quote($$QTC_DOCS_OUTPUTDIR/$${QTC_DOCS_TARGET}.qhp) -o $$shell_quote($$IDE_DOC_PATH/$${QTC_DOCS_TARGET}.qch)
+ qch_docs_$${QTC_DOCS_TARGET}.depends = html_docs_$${QTC_DOCS_TARGET}
+ QMAKE_EXTRA_TARGETS += qch_docs_$${QTC_DOCS_TARGET}
+
!isEmpty(qch_docs.commands): qch_docs.commands += &&
- qch_docs.commands += $$QHELPGENERATOR $$shell_quote($$QTC_DOCS_OUTPUTDIR/$${QTC_DOCS_TARGET}.qhp) -o $$shell_quote($$IDE_DOC_PATH/$${QTC_DOCS_TARGET}.qch)
+ qch_docs.commands += $$eval(qch_docs_$${QTC_DOCS_TARGET}.commands)
inst_qch_docs.files += $$IDE_DOC_PATH/$${QTC_DOCS_TARGET}.qch
}
diff --git a/scripts/createDevPackage.py b/scripts/createDevPackage.py
index 64c74e0ba14..f9b7a3f0e3c 100755
--- a/scripts/createDevPackage.py
+++ b/scripts/createDevPackage.py
@@ -58,6 +58,7 @@ def parse_arguments():
source_include_patterns = [
# directories
r"^scripts/.*$", # everything under scripts/
+ r"^doc/.*$", # everything under doc/
r"^share/(qtcreator/(qml/(qmlpuppet/(.*/)?)?)?)?$", # for shared headers for qt quick designer plugins
r"^src/(.*/)?$", # all directories under src/
r"^plugins/(.*/)?$", # all directories under plugins/ (if this is run on extra plugin repositories)
diff --git a/tests/system/suite_HELP/tst_HELP06/test.py b/tests/system/suite_HELP/tst_HELP06/test.py
index 610ebc23fdf..d1d87f0b048 100755
--- a/tests/system/suite_HELP/tst_HELP06/test.py
+++ b/tests/system/suite_HELP/tst_HELP06/test.py
@@ -57,8 +57,10 @@ def main():
doubleClick(manualQMIObj, 5, 5, 0, Qt.LeftButton)
if not waitFor("not manualQMIObj.collapsed", 2000):
test.warning("It takes more than two seconds to expand the help content tree.")
+ gettingStartedQModelIndex = getQModelIndexStr("text='Getting Started'", manualQModelIndex)
+ doubleClick(gettingStartedQModelIndex, 5, 5, 0, Qt.LeftButton)
mouseClick(waitForObject(getQModelIndexStr("text='Building and Running an Example'",
- manualQModelIndex)), 5, 5, 0, Qt.LeftButton)
+ gettingStartedQModelIndex)))
helpSelector = waitForObject(":Qt Creator_HelpSelector_QComboBox")
pageOpened = "str(helpSelector.currentText).startswith('Building and Running an Example')"
if not waitFor(pageOpened, 10000):