diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-12-12 15:09:43 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-12-13 15:29:06 +0100 |
| commit | e8192898ea3d5a9987a24b3ec4c7ca5c9ea8fdfe (patch) | |
| tree | 509dfa0cbe581f14842b8a4ab09053cf88d5242a /sources/pyside6/doc/extras | |
| parent | 4b71168a8f23538f41b34b2d4d5ca263834853fb (diff) | |
shiboken6/Documentation: Prominently display QML types
Previously the link to the QML types list (Qt web documentation) was
automatically inserted into the last paragraph of the module
description. This only had an effect when no PySide module description
was present. Otherwise, it had to be manually added to the module
description which was overlooked for some modules.
To fix this, extend the module documentation obtained from the doc
parsers by the URL to page and format it as a separate section
preceding the class list.
Remove the QML types from the PySide module descriptions.
Pick-to: 6.8
Task-number: PYSIDE-1106
Change-Id: I0b107a81b239405c0258ecff924aef87472f13b0
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/extras')
| -rw-r--r-- | sources/pyside6/doc/extras/QtCharts.rst | 2 | ||||
| -rw-r--r-- | sources/pyside6/doc/extras/QtDataVisualization.rst | 2 | ||||
| -rw-r--r-- | sources/pyside6/doc/extras/QtMultimedia.rst | 2 | ||||
| -rw-r--r-- | sources/pyside6/doc/extras/QtPositioning.rst | 2 | ||||
| -rw-r--r-- | sources/pyside6/doc/extras/QtQml.rst | 2 | ||||
| -rw-r--r-- | sources/pyside6/doc/extras/QtQuickControls2.rst | 1 | ||||
| -rw-r--r-- | sources/pyside6/doc/extras/QtQuickTest.rst | 3 | ||||
| -rw-r--r-- | sources/pyside6/doc/extras/QtSensors.rst | 2 | ||||
| -rw-r--r-- | sources/pyside6/doc/extras/QtWebChannel.rst | 2 | ||||
| -rw-r--r-- | sources/pyside6/doc/extras/QtWebSockets.rst | 2 |
10 files changed, 1 insertions, 19 deletions
diff --git a/sources/pyside6/doc/extras/QtCharts.rst b/sources/pyside6/doc/extras/QtCharts.rst index 8f2d768bf..d14c38453 100644 --- a/sources/pyside6/doc/extras/QtCharts.rst +++ b/sources/pyside6/doc/extras/QtCharts.rst @@ -14,8 +14,6 @@ directive: from PySide6 import QtCharts -The module also provides `QML types <https://doc.qt.io/qt-6/qtcharts-qmlmodule.html>`_ . - .. note:: An instance of QApplication is required for the QML types as the module depends on Qt's \l{Graphics View Framework} for rendering. QGuiApplication is not sufficient. diff --git a/sources/pyside6/doc/extras/QtDataVisualization.rst b/sources/pyside6/doc/extras/QtDataVisualization.rst index 66e2d9523..a90b6a6e8 100644 --- a/sources/pyside6/doc/extras/QtDataVisualization.rst +++ b/sources/pyside6/doc/extras/QtDataVisualization.rst @@ -19,8 +19,6 @@ directive: import PySide6.QtDataVisualization -The module also provides `QML types <https://doc.qt.io/qt-6/qtdatavisualization-qmlmodule.html>`_ . - Articles and Guides ^^^^^^^^^^^^^^^^^^^ diff --git a/sources/pyside6/doc/extras/QtMultimedia.rst b/sources/pyside6/doc/extras/QtMultimedia.rst index 527c2427b..7d7739fce 100644 --- a/sources/pyside6/doc/extras/QtMultimedia.rst +++ b/sources/pyside6/doc/extras/QtMultimedia.rst @@ -29,8 +29,6 @@ directive: import PySide6.QtMultimedia -The module also provides QML `types <https://doc.qt.io/qt-6/qtmultimedia-qmlmodule.html>`_ . - Overviews and Important Topics ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/sources/pyside6/doc/extras/QtPositioning.rst b/sources/pyside6/doc/extras/QtPositioning.rst index 800e369fa..ee4d32c49 100644 --- a/sources/pyside6/doc/extras/QtPositioning.rst +++ b/sources/pyside6/doc/extras/QtPositioning.rst @@ -23,8 +23,6 @@ directive: import PySide6.QtPositioning -The module also provides `QML types <https://doc.qt.io/qt-6/qtpositioning-qmlmodule.html>`_ . - To load the Qt Positioning module, add the following statement to your .qml files :: diff --git a/sources/pyside6/doc/extras/QtQml.rst b/sources/pyside6/doc/extras/QtQml.rst index 66f736f02..7a12bfb68 100644 --- a/sources/pyside6/doc/extras/QtQml.rst +++ b/sources/pyside6/doc/extras/QtQml.rst @@ -26,8 +26,6 @@ directive: import PySide6.QtQml -The module also provides `QML types <https://doc.qt.io/qt-6/qtqml-qmlmodule.html>`_ . - QML and QML Types ^^^^^^^^^^^^^^^^^ diff --git a/sources/pyside6/doc/extras/QtQuickControls2.rst b/sources/pyside6/doc/extras/QtQuickControls2.rst index 07a923d5a..dcd5ea1ba 100644 --- a/sources/pyside6/doc/extras/QtQuickControls2.rst +++ b/sources/pyside6/doc/extras/QtQuickControls2.rst @@ -35,7 +35,6 @@ Topics ^^^^^^ * `Getting Started <https://doc.qt.io/qt-6/qtquickcontrols2-gettingstarted.html>`_ - * `QML types <https://doc.qt.io/qt-6/qtquick-controls-qmlmodule.html>`_ * `Guidelines <https://doc.qt.io/qt-6/qtquickcontrols2-guidelines.html>`_ * `Styling <https://doc.qt.io/qt-6/qtquickcontrols2-styles.html>`_ * `Icons <https://doc.qt.io/qt-6/qtquickcontrols2-icons.html>`_ diff --git a/sources/pyside6/doc/extras/QtQuickTest.rst b/sources/pyside6/doc/extras/QtQuickTest.rst index 52f13590b..fefd51f5c 100644 --- a/sources/pyside6/doc/extras/QtQuickTest.rst +++ b/sources/pyside6/doc/extras/QtQuickTest.rst @@ -24,8 +24,7 @@ executed. QML API ^^^^^^^ -The `QML types <https://doc.qt.io/qt-6/qttest-qmlmodule.html>`_ -in Qt Quick Test are available through the ``QtTest`` import. +The QML types in Qt Quick Test are available through the ``QtTest`` import. To use the types, add the following import statement to your ``.qml`` file: .. code-block:: JavaScript diff --git a/sources/pyside6/doc/extras/QtSensors.rst b/sources/pyside6/doc/extras/QtSensors.rst index 03a4d5477..3355d1a4e 100644 --- a/sources/pyside6/doc/extras/QtSensors.rst +++ b/sources/pyside6/doc/extras/QtSensors.rst @@ -15,5 +15,3 @@ directive: :: import PySide6.QtSensors - -The module also provides `QML types <https://doc.qt.io/qt-6/qtsensors-qmlmodule.html>`_ . diff --git a/sources/pyside6/doc/extras/QtWebChannel.rst b/sources/pyside6/doc/extras/QtWebChannel.rst index 5207a3486..5e469d513 100644 --- a/sources/pyside6/doc/extras/QtWebChannel.rst +++ b/sources/pyside6/doc/extras/QtWebChannel.rst @@ -26,5 +26,3 @@ API Reference ^^^^^^^^^^^^^ * `JavaScript API <https://doc.qt.io/qt-6/qtwebchannel-javascript.html>`_ - -The module also provides `QML types <https://doc.qt.io/qt-6/qtwebchannel-qmlmodule.html>`_ . diff --git a/sources/pyside6/doc/extras/QtWebSockets.rst b/sources/pyside6/doc/extras/QtWebSockets.rst index f15264699..ec81f738f 100644 --- a/sources/pyside6/doc/extras/QtWebSockets.rst +++ b/sources/pyside6/doc/extras/QtWebSockets.rst @@ -20,8 +20,6 @@ directive: import PySide6.QtWebSockets -The module also provides `QML types <https://doc.qt.io/qt-6/qtwebsockets-qmlmodule.html>`_ . - Articles and Guides ^^^^^^^^^^^^^^^^^^^ |