diff --git a/doc/src/platforms/linux.qdoc b/doc/src/platforms/linux.qdoc index 86c0b0fa0d2b7a8c1fe081dfefc101737301b9f8..466485381e5ee0dab6e2b58dd200e59554bbc806 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 632620b8375d08d0c195a5c9746711dc6e428ce6..0a3ae32dcdd50d2ed4db4840570532f9b63cae0e 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 76bf4be7ea6719176b48dd093c4a7719df2f7bd0..8e92e6ce30d8d8747eba0e2aa72a6c2078b4f248 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 90ff36132f4d2abdf1dd2015437041beac2f8d8c..44d9a77554e07d291b14c8a53e6a59ae239ca95b 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]