diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2023-03-23 09:10:25 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2023-03-28 08:25:46 +0100 |
| commit | fb163f09bf9d55697f6556a86347717395fb4392 (patch) | |
| tree | 08f0e143240506cb1663fc9ee6e7422ba4076a92 /sources/pyside6/doc/gettingstarted | |
| parent | ed68eec67393338d1019ad9babb03aa7d3e1bc1c (diff) | |
Documentation: Add hints about intersphinx troubleshooting
Task-number: PYSIDE-1106
Pick-to: 6.5
Change-Id: Ib58321eb8e433b054aa6a8ce727309cb8cdf551c
Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
Diffstat (limited to 'sources/pyside6/doc/gettingstarted')
| -rw-r--r-- | sources/pyside6/doc/gettingstarted/index.rst | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/sources/pyside6/doc/gettingstarted/index.rst b/sources/pyside6/doc/gettingstarted/index.rst index 1cc587be8..9de7587c4 100644 --- a/sources/pyside6/doc/gettingstarted/index.rst +++ b/sources/pyside6/doc/gettingstarted/index.rst @@ -463,7 +463,7 @@ Since the process relies on a Qt installation, you need to specify where the the command line option ``--qt-src-dir``. Once the common ``setup.py`` build process finishes (remember to use -``--build-docs`` to enable the documentation build, and ``--doc-build-inline`` +``--build-docs`` to enable the documentation build, and ``--doc-build-online`` to get the HTML files), you can go to the generated ``build/<your_env_name>/build/pyside6`` directory, and run:: @@ -472,7 +472,7 @@ to get the HTML files), you can go to the generated You can add ``-j X``, to perform the build process in parallel with X processes. -.. note:: The :command:`apidoc` make target builds offline documentation in QCH (Qt Creator Help) +.. note:: The :command:`apidoc` make target builds offline documentation in ``QCH`` (Qt Creator Help) format by default. You can switch to building for the online use with the ``--doc-build-online`` configure option. @@ -509,6 +509,17 @@ Qt Assistant:: assistant -register PySide.qch +Troubleshooting documentation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The documentation uses intersphinx to link from the PySide to the +Shiboken documentation. This can fail if + +* the default ``QCH`` format is used; in which case the required ``objects.inv`` + files are not generated. Use ``--doc-build-online``. +* rst-only and full doc builds are mixed, resulting in wrong values for the + intersphinx location in the CMake files. Re-run ``cmake`` to fix this. + Using the internal tools ------------------------ |