diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-06-17 10:39:41 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-06-17 15:54:12 +0200 |
| commit | ae91cc112abae0f3f6d400c651985672163484db (patch) | |
| tree | 5cce1209ca23a896b137c468ade0aa88669e077e /sources/pyside6/doc/tools | |
| parent | 0cc582b69915b69b66d0ca589c3de6efd48332f0 (diff) | |
Fix some documentation warnings and broken links
Pick-to: 6.7
Change-Id: I5fbc1be390c7d24ef7f204721cd060e5d61c88e0
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/tools')
| -rw-r--r-- | sources/pyside6/doc/tools/pyside-qml.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/sources/pyside6/doc/tools/pyside-qml.rst b/sources/pyside6/doc/tools/pyside-qml.rst index 0502dd94a..6279aad2b 100644 --- a/sources/pyside6/doc/tools/pyside-qml.rst +++ b/sources/pyside6/doc/tools/pyside-qml.rst @@ -3,16 +3,16 @@ pyside6-qml =========== -``pyside6-qml`` mimics some capabilities of Qt's `qml <qml_runtime>`_ runtime utility by directly +``pyside6-qml`` mimics some capabilities of Qt's `qml`_ runtime utility by directly invoking QQmlEngine/QQuickView. It enables prototyping with QML/QtQuick without the need to write -any Python code that loads the QML files either through `QQmlApplicationEngine <qqmlappengine>`_ or -the `QQuickView <qquickview>`_ class. The tool also detects the QML classes implemented in Python +any Python code that loads the QML files either through `QQmlApplicationEngine`_ or +the `QQuickView`_ class. The tool also detects the QML classes implemented in Python and registers them with the QML type system. Usage ----- -Consider the example `Extending QML - Plugins Example <extending_qml_example>`_. This example does +Consider the example `Extending QML - Plugins Example`_. This example does not have a Python file with a ``main`` function that initializes a QmlEngine to load the QML file ``app.qml``. You can run the example by running @@ -50,8 +50,8 @@ Options * **--verbose/-v**: Run ``pyside6-qml`` in verbose mode. When run in this mode, pyside6-qml prints log messages during various stages of processing. -Options that align with `QML <qml_runtime>`_ runtime utility -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Options that align with the `qml`_ runtime utility +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * **--app-typ/-a**: Specifies which application class to use. It takes one of the three values - ``core, gui, widget``. The default value is *gui*. @@ -78,7 +78,7 @@ Options that align with `QML <qml_runtime>`_ runtime utility * **--disable-context-sharing**: Disable the use of a shared GL context for QtQuick Windows". -.. _`qml_runtime`: https://doc.qt.io/qt-6/qtquick-qml-runtime.html -.. _`qqmlappengine`: https://doc.qt.io/qt-6/qqmlapplicationengine.html -.. _`qquickview`: https://doc.qt.io/qt-6/qquickview.html -.. _`extending_qml_example`: https://doc.qt.io/qtforpython-6/examples/example_qml_tutorials_extending-qml_chapter6-plugins.html +.. _`qml`: https://doc.qt.io/qt-6/qtquick-qml-runtime.html +.. _`QQmlApplicationEngine`: https://doc.qt.io/qt-6/qqmlapplicationengine.html +.. _`QQuickView`: https://doc.qt.io/qt-6/qquickview.html +.. _`Extending QML - Plugins Example`: https://doc.qt.io/qtforpython-6/examples/example_qml_tutorials_extending-qml_chapter6-plugins.html |