feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Update documentation writing instructions

Browse Source 
The location of the TOC file and the built documents has
changed. Qt WebKit has been deprecated. Added a link to doc
build instructions.

Change-Id: I1718e1c706a7e3fd34d2fa44116c0d5631b50f5e
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2017-03-10 09:46:07 +01:00
parent 9c736b68f5
commit e67db17c09
1 changed files with 18 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
doc/api/qtcreator-documentation.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2016 The Qt Company Ltd. ** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** 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} 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 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 readers, you must also add them to the table of contents
page and previous page links to them from other topics. (\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 \section2 Creating Folders and Files
@@ -110,9 +111,11 @@
commands to the topic, with dummy values (for example, commands to the topic, with dummy values (for example,
\c {\nextpage=anything.html}). \c {\nextpage=anything.html}).
\note The script creates the links according to the TOC on the front page. \note The script creates the links according to the TOC in the topic set as
If your topics are not listed in the TOC, the script removes the the value of the \c indexTitle configuration parameter
\c {\nextpage} and \c {\previouspage} commands from them. (\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, To run the script, you must have Perl installed. If you build Qt yourself,
you should already have it. Otherwise, download and install you should already have it. Otherwise, download and install
@@ -245,6 +248,11 @@
The error messages that QDoc issues are generally very useful for The error messages that QDoc issues are generally very useful for
troubleshooting. 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 content and formatting of documentation are separated in QDoc.
The documentation configuration, style sheets, and templates have The documentation configuration, style sheets, and templates have
changed over time, so they differ between Qt and \QC versions. Since \QC changed over time, so they differ between Qt and \QC versions. Since \QC
@@ -266,9 +274,8 @@
running it on a web server. running it on a web server.
\note If the styles look wrong to you when reading help files in \QC or \QA, \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 you might be looking at them in the QTextBrowser instead of the Qr WebEngine
browser. This happens if you build \QC and \QA with a self-built Qt and did browser. This happens if you do not have Qt WebEngine installed.
not build Qt WebKit.
To build documentation for the sources from the qtcreator master branch, use 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 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) \li make docs (on Linux and \macos)
\endlist \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 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 \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 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 on \macos. You can view the HTML files in a browser and the help files in