diff options
32 files changed, 26 insertions, 68 deletions
diff --git a/examples/designer/taskmenuextension/doc/taskmenuextension.rst b/examples/designer/taskmenuextension/doc/taskmenuextension.rst index dd7fe1679..cbd893afc 100644 --- a/examples/designer/taskmenuextension/doc/taskmenuextension.rst +++ b/examples/designer/taskmenuextension/doc/taskmenuextension.rst @@ -1,5 +1,3 @@ -.. _task-menu-extension-example: - Task Menu Extension Example =========================== diff --git a/examples/gui/rhiwindow/doc/rhiwindow.rst b/examples/gui/rhiwindow/doc/rhiwindow.rst index defbc46ef..9d312080a 100644 --- a/examples/gui/rhiwindow/doc/rhiwindow.rst +++ b/examples/gui/rhiwindow/doc/rhiwindow.rst @@ -1,5 +1,3 @@ -.. _rhi-window-example: - RHI Window Example ================== diff --git a/examples/qml/tutorials/extending-qml-advanced/adding/doc/adding.rst b/examples/qml/tutorials/extending-qml-advanced/adding/doc/adding.rst index 4c1b3bdae..a18acb4b7 100644 --- a/examples/qml/tutorials/extending-qml-advanced/adding/doc/adding.rst +++ b/examples/qml/tutorials/extending-qml-advanced/adding/doc/adding.rst @@ -1,5 +1,3 @@ -.. _qml-adding-types-example: - Extending QML - Adding Types Example ==================================== diff --git a/examples/qml/tutorials/extending-qml-advanced/advanced1-Base-project/doc/advanced1-Base-project.rst b/examples/qml/tutorials/extending-qml-advanced/advanced1-Base-project/doc/advanced1-Base-project.rst index 90a73b78d..878b122c7 100644 --- a/examples/qml/tutorials/extending-qml-advanced/advanced1-Base-project/doc/advanced1-Base-project.rst +++ b/examples/qml/tutorials/extending-qml-advanced/advanced1-Base-project/doc/advanced1-Base-project.rst @@ -1,5 +1,3 @@ -.. _qml-advanced1-base-project: - Extending QML (advanced) - BirthdayParty Base Project ===================================================== diff --git a/examples/qml/tutorials/extending-qml-advanced/advanced2-Inheritance-and-coercion/doc/advanced2-Inheritance-and-coercion.rst b/examples/qml/tutorials/extending-qml-advanced/advanced2-Inheritance-and-coercion/doc/advanced2-Inheritance-and-coercion.rst index 16c0dbc9a..f5e989044 100644 --- a/examples/qml/tutorials/extending-qml-advanced/advanced2-Inheritance-and-coercion/doc/advanced2-Inheritance-and-coercion.rst +++ b/examples/qml/tutorials/extending-qml-advanced/advanced2-Inheritance-and-coercion/doc/advanced2-Inheritance-and-coercion.rst @@ -1,5 +1,3 @@ -.. _qml-advanced2-inheritance-and-coercion: - Extending QML (advanced) - Inheritance and Coercion =================================================== diff --git a/examples/qml/tutorials/extending-qml-advanced/advanced3-Default-properties/doc/advanced3-Default-properties.rst b/examples/qml/tutorials/extending-qml-advanced/advanced3-Default-properties/doc/advanced3-Default-properties.rst index 0857f9d0a..c2cb5ecc0 100644 --- a/examples/qml/tutorials/extending-qml-advanced/advanced3-Default-properties/doc/advanced3-Default-properties.rst +++ b/examples/qml/tutorials/extending-qml-advanced/advanced3-Default-properties/doc/advanced3-Default-properties.rst @@ -1,5 +1,3 @@ -.. _qml-advanced3-default-properties: - Extending QML (advanced) - Default Properties ============================================= diff --git a/examples/qml/tutorials/extending-qml-advanced/advanced4-Grouped-properties/doc/advanced4-Grouped-properties.rst b/examples/qml/tutorials/extending-qml-advanced/advanced4-Grouped-properties/doc/advanced4-Grouped-properties.rst index 7748d3189..ff5dbf6ba 100644 --- a/examples/qml/tutorials/extending-qml-advanced/advanced4-Grouped-properties/doc/advanced4-Grouped-properties.rst +++ b/examples/qml/tutorials/extending-qml-advanced/advanced4-Grouped-properties/doc/advanced4-Grouped-properties.rst @@ -1,5 +1,3 @@ -.. _qml-advanced-advanced4-grouped-properties: - Extending QML (advanced) - Grouped Properties ============================================= diff --git a/examples/qml/tutorials/extending-qml-advanced/advanced5-Attached-properties/doc/advanced5-Attached-properties.rst b/examples/qml/tutorials/extending-qml-advanced/advanced5-Attached-properties/doc/advanced5-Attached-properties.rst index 14b4bddb0..c81d02b53 100644 --- a/examples/qml/tutorials/extending-qml-advanced/advanced5-Attached-properties/doc/advanced5-Attached-properties.rst +++ b/examples/qml/tutorials/extending-qml-advanced/advanced5-Attached-properties/doc/advanced5-Attached-properties.rst @@ -1,5 +1,3 @@ -.. _qml-advanced-advanced5-attached-properties: - Extending QML (advanced) - Attached Properties ============================================== diff --git a/examples/qml/tutorials/extending-qml-advanced/advanced6-Property-value-source/doc/advanced6-Property-value-source.rst b/examples/qml/tutorials/extending-qml-advanced/advanced6-Property-value-source/doc/advanced6-Property-value-source.rst index 4e1dc393a..7b00b09bb 100644 --- a/examples/qml/tutorials/extending-qml-advanced/advanced6-Property-value-source/doc/advanced6-Property-value-source.rst +++ b/examples/qml/tutorials/extending-qml-advanced/advanced6-Property-value-source/doc/advanced6-Property-value-source.rst @@ -1,5 +1,3 @@ -.. _qml-advanced/advanced6-property-value-source: - Extending QML (advanced) - Property Value Source ================================================ diff --git a/examples/qml/tutorials/extending-qml-advanced/binding/doc/binding.rst b/examples/qml/tutorials/extending-qml-advanced/binding/doc/binding.rst index e6bc1ac0d..8ffffa79f 100644 --- a/examples/qml/tutorials/extending-qml-advanced/binding/doc/binding.rst +++ b/examples/qml/tutorials/extending-qml-advanced/binding/doc/binding.rst @@ -1,14 +1,12 @@ -.. _qml-binding-example: - Extending QML - Binding Example =============================== -This example builds on the :ref:`qml-adding-types-example`, -the :ref:`qml-advanced-advanced5-attached-properties`, -the :ref:`qml-advanced3-default-properties`, -the :ref:`qml-advanced2-inheritance-and-coercion` -the :ref:`qml-object-and-list-property-types-example` -and the :ref:`qml-advanced/advanced6-property-value-source`. +This example builds on the :ref:`example_qml_tutorials_extending-qml-advanced_adding`, +the :ref:`example_qml_tutorials_extending-qml-advanced_advanced5-attached-properties`, +the :ref:`example_qml_tutorials_extending-qml-advanced_advanced3-default-properties`, +the :ref:`example_qml_tutorials_extending-qml-advanced_advanced2-inheritance-and-coercion` +the :ref:`example_qml_tutorials_extending-qml-advanced_properties` +and the :ref:`example_qml_tutorials_extending-qml-advanced_advanced6-property-value-source`. Running the Example ------------------- diff --git a/examples/qml/tutorials/extending-qml-advanced/extended/doc/extended.rst b/examples/qml/tutorials/extending-qml-advanced/extended/doc/extended.rst index 745960535..0df21716e 100644 --- a/examples/qml/tutorials/extending-qml-advanced/extended/doc/extended.rst +++ b/examples/qml/tutorials/extending-qml-advanced/extended/doc/extended.rst @@ -1,9 +1,7 @@ -.. _qml-extension-objects-example: - Extending QML - Extension Objects Example ========================================= -This example builds on the the :ref:`qml-adding-types-example`. +This example builds on the the :ref:`example_qml_tutorials_extending-qml-advanced_adding`. Shows how to use QmlExtended decorator to provide an extension object to a QLineEdit without modifying or subclassing it. diff --git a/examples/qml/tutorials/extending-qml-advanced/methods/doc/methods.rst b/examples/qml/tutorials/extending-qml-advanced/methods/doc/methods.rst index bda2ede5a..8f8bb5ae3 100644 --- a/examples/qml/tutorials/extending-qml-advanced/methods/doc/methods.rst +++ b/examples/qml/tutorials/extending-qml-advanced/methods/doc/methods.rst @@ -1,11 +1,9 @@ -.. _qml-methods-example: - Extending QML - Methods Example =============================== -This example builds on the :ref:`qml-adding-types-example`, -the :ref:`qml-object-and-list-property-types-example` and -the :ref:`qml-inheritance-and-coercion-example`. +This example builds on the :ref:`example_qml_tutorials_extending-qml-advanced_adding`, +the :ref:`example_qml_tutorials_extending-qml-advanced_properties` and +the :ref:`example_qml_tutorials_extending-qml-advanced_advanced2-inheritance-and-coercion`. The Methods Example has an additional method in the ``BirthdayParty`` class: ``invite()``. ``invite()`` is decorated with ``@Slot`` so that it can be diff --git a/examples/qml/tutorials/extending-qml-advanced/properties/doc/properties.rst b/examples/qml/tutorials/extending-qml-advanced/properties/doc/properties.rst index 16924cdcd..6655187e2 100644 --- a/examples/qml/tutorials/extending-qml-advanced/properties/doc/properties.rst +++ b/examples/qml/tutorials/extending-qml-advanced/properties/doc/properties.rst @@ -1,11 +1,9 @@ -.. _qml-object-and-list-property-types-example: - Extending QML - Object and List Property Types Example ====================================================== Exporting C++ Properties. -This example builds on :ref:`qml-adding-types-example`. +This example builds on :ref:`example_qml_tutorials_extending-qml-advanced_adding`. The Object and List Property Types example shows how to add object and list properties in QML. This example adds a BirthdayParty type that specifies a diff --git a/examples/qml/tutorials/extending-qml/chapter1-basics/doc/chapter1-basics.rst b/examples/qml/tutorials/extending-qml/chapter1-basics/doc/chapter1-basics.rst index 38233aae2..f1ffad446 100644 --- a/examples/qml/tutorials/extending-qml/chapter1-basics/doc/chapter1-basics.rst +++ b/examples/qml/tutorials/extending-qml/chapter1-basics/doc/chapter1-basics.rst @@ -1,5 +1,3 @@ -.. _qml-chapter1-basics: - Extending QML - Creating a New Type =================================== diff --git a/examples/qml/tutorials/extending-qml/chapter2-methods/doc/chapter2-methods.rst b/examples/qml/tutorials/extending-qml/chapter2-methods/doc/chapter2-methods.rst index 245d0ddb2..6ba62cd8a 100644 --- a/examples/qml/tutorials/extending-qml/chapter2-methods/doc/chapter2-methods.rst +++ b/examples/qml/tutorials/extending-qml/chapter2-methods/doc/chapter2-methods.rst @@ -1,5 +1,3 @@ -.. _qml-chapter2-methods: - Extending QML - Connecting to C++ Methods and Signals ===================================================== diff --git a/examples/qml/tutorials/extending-qml/chapter3-bindings/doc/chapter3-bindings.rst b/examples/qml/tutorials/extending-qml/chapter3-bindings/doc/chapter3-bindings.rst index 3b7191191..2d6649ab9 100644 --- a/examples/qml/tutorials/extending-qml/chapter3-bindings/doc/chapter3-bindings.rst +++ b/examples/qml/tutorials/extending-qml/chapter3-bindings/doc/chapter3-bindings.rst @@ -1,5 +1,3 @@ -.. _qml-chapter3-bindings: - Extending QML - Adding Property Bindings ======================================== diff --git a/examples/qml/tutorials/extending-qml/chapter4-customPropertyTypes/doc/chapter4-customPropertyTypes.rst b/examples/qml/tutorials/extending-qml/chapter4-customPropertyTypes/doc/chapter4-customPropertyTypes.rst index f7c3efb11..13d1b6f99 100644 --- a/examples/qml/tutorials/extending-qml/chapter4-customPropertyTypes/doc/chapter4-customPropertyTypes.rst +++ b/examples/qml/tutorials/extending-qml/chapter4-customPropertyTypes/doc/chapter4-customPropertyTypes.rst @@ -1,5 +1,3 @@ -.. _qml-chapter4-custompropertytypes: - Extending QML - Using Custom Property Types =========================================== diff --git a/examples/qml/tutorials/extending-qml/chapter5-listproperties/doc/chapter5-listproperties.rst b/examples/qml/tutorials/extending-qml/chapter5-listproperties/doc/chapter5-listproperties.rst index a98f18c81..ece79e9d6 100644 --- a/examples/qml/tutorials/extending-qml/chapter5-listproperties/doc/chapter5-listproperties.rst +++ b/examples/qml/tutorials/extending-qml/chapter5-listproperties/doc/chapter5-listproperties.rst @@ -1,5 +1,3 @@ -.. _qml-chapter5-listproperties: - Extending QML - Using List Property Types ========================================= diff --git a/examples/qml/tutorials/extending-qml/chapter6-plugins/doc/chapter6-plugins.rst b/examples/qml/tutorials/extending-qml/chapter6-plugins/doc/chapter6-plugins.rst index a9d100812..95b14a77d 100644 --- a/examples/qml/tutorials/extending-qml/chapter6-plugins/doc/chapter6-plugins.rst +++ b/examples/qml/tutorials/extending-qml/chapter6-plugins/doc/chapter6-plugins.rst @@ -1,5 +1,3 @@ -.. _qml-chapter6-plugins-example: - Extending QML - Plugins Example =============================== diff --git a/examples/quickcontrols/filesystemexplorer/doc/filesystemexplorer.rst b/examples/quickcontrols/filesystemexplorer/doc/filesystemexplorer.rst index b46cbec79..98034ba49 100644 --- a/examples/quickcontrols/filesystemexplorer/doc/filesystemexplorer.rst +++ b/examples/quickcontrols/filesystemexplorer/doc/filesystemexplorer.rst @@ -1,5 +1,3 @@ -.. _filesystemexplorer_example: - Qt Quick Controls - Filesystem Explorer ======================================= diff --git a/examples/widgets/gettext/doc/gettext.rst b/examples/widgets/gettext/doc/gettext.rst index ea1127fe7..9c00591fd 100644 --- a/examples/widgets/gettext/doc/gettext.rst +++ b/examples/widgets/gettext/doc/gettext.rst @@ -1,5 +1,3 @@ -.. _gettext-example: - GNU gettext Example =================== diff --git a/examples/widgets/linguist/doc/linguist.rst b/examples/widgets/linguist/doc/linguist.rst index 24a49a617..169688a49 100644 --- a/examples/widgets/linguist/doc/linguist.rst +++ b/examples/widgets/linguist/doc/linguist.rst @@ -1,5 +1,3 @@ -.. _qt-linguist-example: - Qt Linguist Example =================== diff --git a/examples/widgets/rhi/simplerhiwidget/doc/simplerhiwidget.rst b/examples/widgets/rhi/simplerhiwidget/doc/simplerhiwidget.rst index c33c6660a..65cfacd85 100644 --- a/examples/widgets/rhi/simplerhiwidget/doc/simplerhiwidget.rst +++ b/examples/widgets/rhi/simplerhiwidget/doc/simplerhiwidget.rst @@ -1,12 +1,10 @@ -.. _rhi-widget-example: - Simple RHI Widget Example ========================= Shows how to render a triangle using ``QRhi``, Qt's 3D API and shading language abstraction layer. -This example is, in many ways, the counterpart of the :ref:`rhi-window-example` +This example is, in many ways, the counterpart of the :ref:`example_gui_rhiwindow` in the QWidget world. The ``QRhiWidget`` subclass in this applications renders a single triangle, using a simple graphics pipeline with basic vertex and fragment shaders. Unlike the plain ``QWindow``-based application, this example diff --git a/sources/pyside6/doc/developer/add_port_example.rst b/sources/pyside6/doc/developer/add_port_example.rst index b99641f45..18f826bc3 100644 --- a/sources/pyside6/doc/developer/add_port_example.rst +++ b/sources/pyside6/doc/developer/add_port_example.rst @@ -48,6 +48,10 @@ Add a new example in the ``doc`` directory containing some description explaining them (see the `samplebinding` example). +.. note:: The ``example_gallery`` tools automatically prepends an + auto-generated anchor to the example documentation, please use those for + linking to the documentation. + Port a Qt example ----------------- diff --git a/sources/pyside6/doc/extras/QtQml.ListProperty.rst b/sources/pyside6/doc/extras/QtQml.ListProperty.rst index eaa580c68..56747ae6f 100644 --- a/sources/pyside6/doc/extras/QtQml.ListProperty.rst +++ b/sources/pyside6/doc/extras/QtQml.ListProperty.rst @@ -3,8 +3,8 @@ The ``ListProperty`` class allows applications to expose list-like properties of :class:`~PySide6.QtCore.QObject`-derived classes to QML. - The usage is shown in the :ref:`qml-object-and-list-property-types-example` - and the :ref:`qml-chapter5-listproperties` example. + The usage is shown in the :ref:`example_qml_tutorials_extending-qml-advanced_properties` + and the :ref:`example_qml_tutorials_extending-qml_chapter5-listproperties` example. .. py:method:: __init__(type, append, count=None, at=None, clear=None, removeLast=None, doc="", notify=None, designable=True, scriptable=True, stored=True, user=False, constant=False, final=False) diff --git a/sources/pyside6/doc/tools/pyside-designer.rst b/sources/pyside6/doc/tools/pyside-designer.rst index 4cde6b2bf..64574ace7 100644 --- a/sources/pyside6/doc/tools/pyside-designer.rst +++ b/sources/pyside6/doc/tools/pyside-designer.rst @@ -85,7 +85,7 @@ We provide a helper class, ``QPyDesignerCustomWidgetCollection``, to simplify the registration process. If you are interested in all the details of this specific case, you can -check the :ref:`task-menu-extension-example`. +check the :ref:`example_designer_taskmenuextension`. .. _`Qt Widgets Designer`: https://doc.qt.io/qt-6/qtdesigner-manual.html .. _`Qt Widgets Designer Manual`: https://doc.qt.io/qt-6/qtdesigner-manual.html diff --git a/sources/pyside6/doc/tools/pyside-lrelease.rst b/sources/pyside6/doc/tools/pyside-lrelease.rst index 7c628f2aa..215923e66 100644 --- a/sources/pyside6/doc/tools/pyside-lrelease.rst +++ b/sources/pyside6/doc/tools/pyside-lrelease.rst @@ -15,7 +15,7 @@ for translations (see :ref:`translations`). Usage ----- -To convert a ``.ts`` file of the :ref:`qt-linguist-example` +To convert a ``.ts`` file of the :ref:`example_widgets_linguist` into its binary representation, run: .. code-block:: bash diff --git a/sources/pyside6/doc/tools/pyside-lupdate.rst b/sources/pyside6/doc/tools/pyside-lupdate.rst index 1c0d73c15..bf4930bd2 100644 --- a/sources/pyside6/doc/tools/pyside-lupdate.rst +++ b/sources/pyside6/doc/tools/pyside-lupdate.rst @@ -13,7 +13,7 @@ updates ``.ts`` files (see :ref:`translations`). Usage ----- -To create or update the ``.ts`` file of the :ref:`qt-linguist-example`, +To create or update the ``.ts`` file of the :ref:`example_widgets_linguist`, run: .. code-block:: bash diff --git a/sources/pyside6/doc/tools/pyside6-qmlimportscanner.rst b/sources/pyside6/doc/tools/pyside6-qmlimportscanner.rst index ba27414d7..69b162d8a 100644 --- a/sources/pyside6/doc/tools/pyside6-qmlimportscanner.rst +++ b/sources/pyside6/doc/tools/pyside6-qmlimportscanner.rst @@ -14,7 +14,7 @@ the QML source files. Usage ----- -Invoking the tool in the directory of the :ref:`filesystemexplorer_example` +Invoking the tool in the directory of the :ref:`example_quickcontrols_filesystemexplorer` example using: .. code-block:: bash diff --git a/sources/pyside6/doc/tutorials/basictutorial/translations.rst b/sources/pyside6/doc/tutorials/basictutorial/translations.rst index d66362f54..ae675e1ee 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/translations.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/translations.rst @@ -13,7 +13,7 @@ Qt Linguist `Qt Linguist`_ and its related tools can be used to provide translations for applications. -The :ref:`qt-linguist-example` example illustrates this. The example is +The :ref:`example_widgets_linguist` example illustrates this. The example is very simple, it has a menu and shows a list of programming languages with multiselection. @@ -121,7 +121,7 @@ GNU gettext The `GNU gettext`_ module can be used to provide translations for applications. -The :ref:`gettext-example` example illustrates this. The example is +The :ref:`example_widgets_gettext` example illustrates this. The example is very simple, it has a menu and shows a list of programming languages with multiselection. diff --git a/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst b/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst index 9e61ad9c1..32d32300c 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst @@ -223,7 +223,7 @@ Qt for Python provides a simple interface for this which is similar to The widget needs to be provided as a Python module, as shown by the :ref:`widgetbinding-example` (file ``wigglywidget.py``) or -the :ref:`task-menu-extension-example` (file ``tictactoe.py``). +the :ref:`example_designer_taskmenuextension` (file ``tictactoe.py``). Registering this with *Qt Widgets Designer* is done by providing a registration script named ``register*.py`` and pointing diff --git a/sources/pyside6/doc/tutorials/extendedexplorer/extendedexplorer.md b/sources/pyside6/doc/tutorials/extendedexplorer/extendedexplorer.md index f7c58b98e..44fcf8eb4 100644 --- a/sources/pyside6/doc/tutorials/extendedexplorer/extendedexplorer.md +++ b/sources/pyside6/doc/tutorials/extendedexplorer/extendedexplorer.md @@ -3,7 +3,7 @@ # Extending the file system explorer example This tutorial shows how to extend the -[Filesystem Explorer Example](filesystemexplorer_example) +[Filesystem Explorer Example](example_quickcontrols_filesystemexplorer) by adding a simple scheme manager. This feature will allow you to switch color schemes during the application's runtime. The color schemes will be declared in JSON format and made available through a custom Python-QML plugin. |