diff options
| author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2020-05-12 10:18:08 +0200 |
|---|---|---|
| committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2020-06-04 13:14:02 +0200 |
| commit | b405a419aa532ec1c79e91827b30d23358cae841 (patch) | |
| tree | 4c9b6968ea1d696d9bccc34f232f1dd619196621 /sources/pyside2/doc/gettingstarted.rst | |
| parent | ed1a6d48c61b33c94c51fb92619ae173fa5c22c5 (diff) | |
Doc: Enable doc builds using the offline template
A new command-line option, --doc-build-online, enables
to choose online builds, otherwise offline docs are
built by default.
Change-Id: I34ef8a22ef3bd321bd972c4f2873e4321c9c336a
Fixes: PYSIDE-1292
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside2/doc/gettingstarted.rst')
| -rw-r--r-- | sources/pyside2/doc/gettingstarted.rst | 30 |
1 files changed, 28 insertions, 2 deletions
diff --git a/sources/pyside2/doc/gettingstarted.rst b/sources/pyside2/doc/gettingstarted.rst index dbe22a806..4368c0a50 100644 --- a/sources/pyside2/doc/gettingstarted.rst +++ b/sources/pyside2/doc/gettingstarted.rst @@ -63,7 +63,8 @@ Other important options to consider are: * ``--reuse-build``, to rebuild only the modified files, * ``--openssl=/path/to/openssl/bin``, to use a different path for OpenSSL, * ``--standalone``, to copy over the Qt libraries into the final package - to make it work on other machines. + to make it work on other machines, + * ``--doc-build-online``, to build documentation using the online template. Testing the installation ------------------------- @@ -110,7 +111,32 @@ directory, and run:: make apidoc -Finally, you will get a ``html`` directory containing all the generated documentation. +.. note:: The ``apidoc`` make target builds offline documenation in QCH (Qt Creator Help) format + by default. You can switch to building for the online use with the ``--doc-build-online`` + configure option. + +Finally, you will get a ``html`` directory containing all the generated documentation. The offline +help files, ``PySide.qch`` and ``Shiboken.qch``, can be moved to any directory of your choice. You +can find ``Shiboken.qch`` in the build directory, ``*_build\*_release\shiboken2\doc\html``. + +Viewing offline documentation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The offline documentation (QCH) can be viewed using the Qt Creator IDE or Qt Assistant, which is +a standalone application for viewing QCH files. + +To view the QCH using Qt Creator, following the instructions outlined in +`Using Qt Creator Help Mode <https://doc.qt.io/qtcreator/creator-help.html`_. If you chose to +use Qt Assistant instead, use the following command to register the QCH file before launching +Qt Assistant: + + assistant -register PySide.qch + +.. note:: Qt Assistant renders the QCH content using the QTextBrowser backend, which supports + a subset of the CSS sytles only, However, Qt Creator offers an alternative litehtml-based + backend, which offers better browsing experience. At the moment, this is not the default + backend, so you have to select the litehtml backend + explicitly under the ``General`` tab in ``Qt Creator >> Tools >> Options >> Help``. Using the internal tools ------------------------ |