diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-08-16 14:51:15 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-08-16 16:03:13 +0200 |
| commit | 1e9ab846e7b59f98b57bd22c17840472619fa85e (patch) | |
| tree | 7863e51d0214e9e182a874416afd88e9e1c1b9d0 /sources/pyside6 | |
| parent | 96e233535c05462ea0ddaa72ce88c0ccc6fbf45b (diff) | |
Documentation: Remove example anchors
The example_gallery tools also adds anchors, use these instead.
Change-Id: I488250fae608cf50804c3edfe0ec12d4aa08194a
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6')
9 files changed, 14 insertions, 10 deletions
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. |