diff options
| author | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2024-08-09 17:04:58 +0200 |
|---|---|---|
| committer | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2024-08-15 16:03:19 +0200 |
| commit | d2318d7aab3616df6e589b6337d2c2b8cd6e1909 (patch) | |
| tree | 269da6d999df3c0e26977221ba303e88cf91a3dd /sources/pyside6/doc/tutorials | |
| parent | 3f78f5f1a47484d0da2b2c1e8aa623d10de4db80 (diff) | |
Docs: Update tutorial to use sphinx references
- Changed relative paths to use sphinx references.
Task-number: PYSIDE-2837
Change-Id: Ia581af3820650ea35b675a1b360779bcaabd84bb
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/tutorials')
26 files changed, 100 insertions, 22 deletions
diff --git a/sources/pyside6/doc/tutorials/basictutorial/clickablebutton.rst b/sources/pyside6/doc/tutorials/basictutorial/clickablebutton.rst index c5464640b..dfda3f1ff 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/clickablebutton.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/clickablebutton.rst @@ -1,3 +1,6 @@ +.. _tutorial_clickablebutton: + + Using a Simple Button ===================== diff --git a/sources/pyside6/doc/tutorials/basictutorial/dialog.rst b/sources/pyside6/doc/tutorials/basictutorial/dialog.rst index b7712672b..fd3e22bf9 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/dialog.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/dialog.rst @@ -1,3 +1,6 @@ +.. _tutorial_dialog: + + Creating a Dialog Application ============================= diff --git a/sources/pyside6/doc/tutorials/basictutorial/qml.rst b/sources/pyside6/doc/tutorials/basictutorial/qml.rst index ba0a08fef..fe1519b84 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/qml.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/qml.rst @@ -1,3 +1,6 @@ +.. _tutorial_qml: + + Your First QtQuick/QML Application ********************************** diff --git a/sources/pyside6/doc/tutorials/basictutorial/qrcfiles.rst b/sources/pyside6/doc/tutorials/basictutorial/qrcfiles.rst index 7554ae10d..b6861f920 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/qrcfiles.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/qrcfiles.rst @@ -1,4 +1,5 @@ -.. _using_qrc_files: +.. _tutorial_qrcfiles: + Using ``.qrc`` Files (``pyside6-rcc``) ************************************** diff --git a/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst b/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst index 0bfd9e276..3e6671da6 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst @@ -1,4 +1,5 @@ -.. _signals-and-slots: +.. _tutorial_signals_and_slots: + Signals and Slots ================= diff --git a/sources/pyside6/doc/tutorials/basictutorial/tablewidget.rst b/sources/pyside6/doc/tutorials/basictutorial/tablewidget.rst index 5c04529fd..ecaedc27e 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/tablewidget.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/tablewidget.rst @@ -1,3 +1,6 @@ +.. _tutorial_tablewidget: + + Displaying Data Using a Table Widget ==================================== diff --git a/sources/pyside6/doc/tutorials/basictutorial/translations.rst b/sources/pyside6/doc/tutorials/basictutorial/translations.rst index 21c16cdcd..d66362f54 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/translations.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/translations.rst @@ -1,4 +1,5 @@ -.. _translations: +.. _tutorial_translations: + Translating Applications ======================== diff --git a/sources/pyside6/doc/tutorials/basictutorial/treewidget.rst b/sources/pyside6/doc/tutorials/basictutorial/treewidget.rst index f431cb5c4..da62abff7 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/treewidget.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/treewidget.rst @@ -1,3 +1,6 @@ +.. _tutorial_treewidget: + + Displaying Data Using a Tree Widget =================================== diff --git a/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst b/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst index cb945908d..9e61ad9c1 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst @@ -1,4 +1,5 @@ -.. _using_ui_files: +.. _tutorial_uifiles: + Using ``.ui`` files from Designer or QtCreator with ``QUiLoader`` and ``pyside6-uic`` ************************************************************************************* diff --git a/sources/pyside6/doc/tutorials/basictutorial/widgets.rst b/sources/pyside6/doc/tutorials/basictutorial/widgets.rst index ef14c7e99..1e640b636 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/widgets.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/widgets.rst @@ -1,3 +1,6 @@ +.. _tutorial_widgets: + + Your First QtWidgets Application ********************************* diff --git a/sources/pyside6/doc/tutorials/basictutorial/widgetstyling.rst b/sources/pyside6/doc/tutorials/basictutorial/widgetstyling.rst index 2fa51c0a8..8f9e3ae96 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/widgetstyling.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/widgetstyling.rst @@ -1,4 +1,5 @@ -.. _widgetstyling: +.. _tutorial_widgetstyling: + Styling the Widgets Application =============================== diff --git a/sources/pyside6/doc/tutorials/datavisualize/add_chart.rst b/sources/pyside6/doc/tutorials/datavisualize/add_chart.rst index 59a9d9ee0..22c27e5fb 100644 --- a/sources/pyside6/doc/tutorials/datavisualize/add_chart.rst +++ b/sources/pyside6/doc/tutorials/datavisualize/add_chart.rst @@ -1,3 +1,6 @@ +.. _tutorial_add_chart: + + Chapter 5 - Add a chart view ============================= diff --git a/sources/pyside6/doc/tutorials/datavisualize/add_mainwindow.rst b/sources/pyside6/doc/tutorials/datavisualize/add_mainwindow.rst index 623372a07..ab5468cd6 100644 --- a/sources/pyside6/doc/tutorials/datavisualize/add_mainwindow.rst +++ b/sources/pyside6/doc/tutorials/datavisualize/add_mainwindow.rst @@ -1,3 +1,6 @@ +.. _tutorial_add_mainwindow: + + Chapter 3 - Create an empty QMainWindow ========================================== diff --git a/sources/pyside6/doc/tutorials/datavisualize/add_tableview.rst b/sources/pyside6/doc/tutorials/datavisualize/add_tableview.rst index f658640bf..6989ace62 100644 --- a/sources/pyside6/doc/tutorials/datavisualize/add_tableview.rst +++ b/sources/pyside6/doc/tutorials/datavisualize/add_tableview.rst @@ -1,3 +1,6 @@ +.. _tutorial_add_tableview: + + Chapter 4 - Add a QTableView ============================= diff --git a/sources/pyside6/doc/tutorials/datavisualize/filter_data.rst b/sources/pyside6/doc/tutorials/datavisualize/filter_data.rst index edfac3862..bef134e5b 100644 --- a/sources/pyside6/doc/tutorials/datavisualize/filter_data.rst +++ b/sources/pyside6/doc/tutorials/datavisualize/filter_data.rst @@ -1,3 +1,6 @@ +.. _tutorial_filter_data: + + Chapter 2 - Filtering data =========================== diff --git a/sources/pyside6/doc/tutorials/datavisualize/index.rst b/sources/pyside6/doc/tutorials/datavisualize/index.rst index 35b56706a..6adf84544 100644 --- a/sources/pyside6/doc/tutorials/datavisualize/index.rst +++ b/sources/pyside6/doc/tutorials/datavisualize/index.rst @@ -1,3 +1,6 @@ +.. _datavisualize_index: + + Data Visualization Tool Tutorial ********************************* diff --git a/sources/pyside6/doc/tutorials/datavisualize/plot_datapoints.rst b/sources/pyside6/doc/tutorials/datavisualize/plot_datapoints.rst index f71fca4c8..e4374e861 100644 --- a/sources/pyside6/doc/tutorials/datavisualize/plot_datapoints.rst +++ b/sources/pyside6/doc/tutorials/datavisualize/plot_datapoints.rst @@ -1,3 +1,6 @@ +.. _tutorial_plot_datapoints: + + Chapter 6 - Plot the data in the ChartView =========================================== diff --git a/sources/pyside6/doc/tutorials/datavisualize/read_data.rst b/sources/pyside6/doc/tutorials/datavisualize/read_data.rst index 53b0d1cb0..8be0e1c2f 100644 --- a/sources/pyside6/doc/tutorials/datavisualize/read_data.rst +++ b/sources/pyside6/doc/tutorials/datavisualize/read_data.rst @@ -1,3 +1,6 @@ +.. _tutorial_read_data: + + Chapter 1 - Reading data from a CSV =================================== diff --git a/sources/pyside6/doc/tutorials/debugging/mixed_debugging.rst b/sources/pyside6/doc/tutorials/debugging/mixed_debugging.rst index 7dd65cd2b..a975ea74e 100644 --- a/sources/pyside6/doc/tutorials/debugging/mixed_debugging.rst +++ b/sources/pyside6/doc/tutorials/debugging/mixed_debugging.rst @@ -1,3 +1,6 @@ +.. _tutorial_mixed_debugging: + + How To Debug a C++ Extension of a PySide6 Application? ****************************************************** diff --git a/sources/pyside6/doc/tutorials/debugging/qml_debugging.rst b/sources/pyside6/doc/tutorials/debugging/qml_debugging.rst index 223e608fc..bf84fecc7 100644 --- a/sources/pyside6/doc/tutorials/debugging/qml_debugging.rst +++ b/sources/pyside6/doc/tutorials/debugging/qml_debugging.rst @@ -1,3 +1,6 @@ +.. _tutorial_qml_debugging: + + Using Qt Creator's QML Debugger for a PySide6 QML Application ************************************************************* diff --git a/sources/pyside6/doc/tutorials/expenses/expenses.rst b/sources/pyside6/doc/tutorials/expenses/expenses.rst index 2064488ae..22723af1f 100644 --- a/sources/pyside6/doc/tutorials/expenses/expenses.rst +++ b/sources/pyside6/doc/tutorials/expenses/expenses.rst @@ -1,3 +1,6 @@ +.. _tutorial_expenses: + + Expenses Tool Tutorial ====================== diff --git a/sources/pyside6/doc/tutorials/extendedexplorer/extendedexplorer.md b/sources/pyside6/doc/tutorials/extendedexplorer/extendedexplorer.md index 0ac7bec18..f7c58b98e 100644 --- a/sources/pyside6/doc/tutorials/extendedexplorer/extendedexplorer.md +++ b/sources/pyside6/doc/tutorials/extendedexplorer/extendedexplorer.md @@ -1,3 +1,5 @@ +(tutorial_extendedexplorer)= + # Extending the file system explorer example This tutorial shows how to extend the diff --git a/sources/pyside6/doc/tutorials/index.rst b/sources/pyside6/doc/tutorials/index.rst index 8a69a3c6f..aabb16201 100644 --- a/sources/pyside6/doc/tutorials/index.rst +++ b/sources/pyside6/doc/tutorials/index.rst @@ -20,70 +20,80 @@ names and how they look like. .. grid-item-card:: Basic Widget :class-item: cover-img - :link: basictutorial/widgets.html + :link: tutorial_widgets + :link-type: ref :img-top: basictutorial/widgets.png Your first QtWidgets Application .. grid-item-card:: Basic Button :class-item: cover-img - :link: basictutorial/clickablebutton.html + :link: tutorial_clickablebutton + :link-type: ref :img-top: basictutorial/clickablebutton.png Using a Simple Button .. grid-item-card:: Basic Connections :class-item: cover-img - :link: basictutorial/signals_and_slots.html + :link: tutorial_signals_and_slots + :link-type: ref :img-top: basictutorial/signals_slots.png Signals and Slots .. grid-item-card:: Basic Dialog :class-item: cover-img - :link: basictutorial/dialog.html + :link: tutorial_dialog + :link-type: ref :img-top: basictutorial/dialog.png Creating a Dialog Application .. grid-item-card:: Basic Table :class-item: cover-img - :link: basictutorial/tablewidget.html + :link: tutorial_tablewidget + :link-type: ref :img-top: basictutorial/tablewidget.png Displaying Data Using a Table Widget .. grid-item-card:: Basic Tree :class-item: cover-img - :link: basictutorial/treewidget.html + :link: tutorial_treewidget + :link-type: ref :img-top: basictutorial/treewidget.png Displaying Data Using a Tree Widget .. grid-item-card:: Basic ``ui`` files :class-item: cover-img - :link: basictutorial/uifiles.html + :link: tutorial_uifiles + :link-type: ref :img-top: basictutorial/uifiles.png Using .ui files from Designer or QtCreator with QUiLoader and pyside6-uic .. grid-item-card:: Basic ``qrc`` files :class-item: cover-img - :link: basictutorial/qrcfiles.html + :link: tutorial_qrcfiles + :link-type: ref :img-top: basictutorial/player-new.png Using .qrc Files (pyside6-rcc) .. grid-item-card:: Basic Translations :class-item: cover-img - :link: basictutorial/translations.html + :link: tutorial_translations + :link-type: ref :img-top: basictutorial/translations.png Translating Applications .. grid-item-card:: Basic Widget Style :class-item: cover-img - :link: basictutorial/widgetstyling.html + :link: tutorial_widgetstyling + :link-type: ref :img-top: basictutorial/widgetstyling-yes.png Styling the Widgets Application @@ -111,35 +121,40 @@ Quick/QML: Basic tutorials .. grid-item-card:: Basic Quick :class-item: cover-img - :link: basictutorial/qml.html + :link: tutorial_qml + :link-type: ref :img-top: basictutorial/greenapplication.png Your First QtQuick/QML Application .. grid-item-card:: Basic QML Integration :class-item: cover-img - :link: qmlintegration/qmlintegration.html + :link: tutorial_qmlintegration + :link-type: ref :img-top: qmlintegration/textproperties_material.png Python-QML integration .. grid-item-card:: QML Application :class-item: cover-img - :link: qmlapp/qmlapplication.html + :link: tutorial_qmlapplication + :link-type: ref :img-top: qmlapp/qmlapplication.png QML Application Tutorial (QtCreator) .. grid-item-card:: Advanced QML Integration :class-item: cover-img - :link: qmlsqlintegration/qmlsqlintegration.html + :link: tutorial_qmlsqlintegration + :link-type: ref :img-top: qmlsqlintegration/example_list_view.png QML, SQL and PySide Integration Tutorial .. grid-item-card:: Extended Explorer :class-item: cover-img - :link: extendedexplorer/extendedexplorer.html + :link: tutorial_extendedexplorer + :link-type: ref :img-top: extendedexplorer/resources/extendedexplorer.webp Extending an Qt Quick Controls example @@ -162,14 +177,16 @@ General Applications .. grid-item-card:: Data Visualization :class-item: cover-img - :link: datavisualize/index.html + :link: datavisualize_index + :link-type: ref :img-top: datavisualize/images/datavisualization_app.png Data Visualization Tool .. grid-item-card:: Expenses Application :class-item: cover-img - :link: expenses/expenses.html + :link: tutorial_expenses + :link-type: ref :img-top: expenses/expenses_tool.png Expenses administration tool diff --git a/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst b/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst index 5b7e7d4e0..e09dee598 100644 --- a/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst +++ b/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst @@ -1,3 +1,5 @@ +.. _tutorial_qmlapplication: + ######################### QML Application Tutorial ######################### diff --git a/sources/pyside6/doc/tutorials/qmlintegration/qmlintegration.rst b/sources/pyside6/doc/tutorials/qmlintegration/qmlintegration.rst index 3d127529c..5bae0bb6c 100644 --- a/sources/pyside6/doc/tutorials/qmlintegration/qmlintegration.rst +++ b/sources/pyside6/doc/tutorials/qmlintegration/qmlintegration.rst @@ -1,3 +1,5 @@ +.. _tutorial_qmlintegration: + Python-QML integration ====================== diff --git a/sources/pyside6/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst b/sources/pyside6/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst index 0edc61193..21d8c9950 100644 --- a/sources/pyside6/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst +++ b/sources/pyside6/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst @@ -1,3 +1,5 @@ +.. _tutorial_qmlsqlintegration: + QML, SQL and PySide Integration Tutorial ######################################## |