diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2019-09-30 11:06:14 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2019-10-02 11:47:50 +0200 |
| commit | ee8b55cc0e5699c73bad500c12dbe62fe057398b (patch) | |
| tree | 2521a58e6f1428466d5cc41a6cf25505771cead4 | |
| parent | b52984369df0ba311a7f7106086d30a799e3bb61 (diff) | |
| download | qtdoc-ee8b55cc0e5699c73bad500c12dbe62fe057398b.tar.gz | |
Describe building Qt reference docs
... as a part of building Qt from sources. Otherwise, the docs
will not be visible in the Qt Assistant that was built.
Fixes: QTBUG-18988
Change-Id: I20c702d46c8996aa070859dcfd9287af9620a67a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
| -rw-r--r-- | doc/src/platforms/linux.qdoc | 9 | ||||
| -rw-r--r-- | doc/src/platforms/macos.qdoc | 11 | ||||
| -rw-r--r-- | doc/src/platforms/windows.qdoc | 8 | ||||
| -rw-r--r-- | doc/src/snippets/code/doc_src_installation.qdoc | 3 |
4 files changed, 27 insertions, 4 deletions
diff --git a/doc/src/platforms/linux.qdoc b/doc/src/platforms/linux.qdoc index 86c0b0fa..46648538 100644 --- a/doc/src/platforms/linux.qdoc +++ b/doc/src/platforms/linux.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -446,6 +446,13 @@ \c LD_LIBRARY_PATH environment variable to include \c{/usr/local/Qt-%VERSION%/lib}. On Linux with GCC this step is not needed. + + \section1 Step 5: Build the Qt Documentation + + For the Qt reference documentation to be available in \l {Qt Assistant}, + you must build it separately: + + \snippet snippets/code/doc_src_installation.qdoc 24 */ /*! diff --git a/doc/src/platforms/macos.qdoc b/doc/src/platforms/macos.qdoc index 632620b8..0a3ae32d 100644 --- a/doc/src/platforms/macos.qdoc +++ b/doc/src/platforms/macos.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -354,7 +354,14 @@ If you use a different shell, please modify your environment variables accordingly. - \b {That's all. Qt is now installed.} + \b {Qt is now installed.} + + \section1 Step 5: Build the Qt Documentation + + For the Qt reference documentation to be available in \l {Qt Assistant}, you + must build it separately: + + \snippet snippets/code/doc_src_installation.qdoc 24 \section1 Limitations diff --git a/doc/src/platforms/windows.qdoc b/doc/src/platforms/windows.qdoc index 76bf4be7..8e92e6ce 100644 --- a/doc/src/platforms/windows.qdoc +++ b/doc/src/platforms/windows.qdoc @@ -1214,4 +1214,12 @@ \l{jom} is a replacement for \c nmake which makes use of all CPU cores and thus speeds up building. + \section1 Step 5: Build the Qt Documentation + + For the Qt reference documentation to be available in \l {Qt Assistant}, + you must build it separately: + + \code + nmake docs + \endcode */ diff --git a/doc/src/snippets/code/doc_src_installation.qdoc b/doc/src/snippets/code/doc_src_installation.qdoc index 90ff3613..44d9a775 100644 --- a/doc/src/snippets/code/doc_src_installation.qdoc +++ b/doc/src/snippets/code/doc_src_installation.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -163,6 +163,7 @@ nmake install //! [24] +make docs //! [24] //! [25] |