aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/tutorials
Commit message (Collapse)AuthorAgeFilesLines
...
* Fix typo in signal/slot tutorialFriedemann Kleint2023-06-301-1/+1
| | | | | | | Pick-to: 6.5 Fixes: PYSIDE-2376 Change-Id: I9b708903dffd52dd09a34086104149d646fdbab8 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Remove mentions of decorator form of signalsFriedemann Kleint2023-04-241-4/+2
| | | | | | | | | | Use class variables instead. Fixes: PYSIDE-2308 Pick-to: 6.5 Change-Id: I4edc07ad2445f05b2db70ca7c1f8e2106177e78b Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: add qrc icons tutorial zipCristián Maureira-Fredes2023-04-122-4/+3
| | | | | | | | | | | the :download: sphinx command doesn't work with directories, so a package is needed to allow people to download them. Pick-to: 6.5 Fixes: PYSIDE-2275 Change-Id: I8599445c30d800d3eae62dc86955b5ec4e982960 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: fix issues with pyside rst filesCristián Maureira-Fredes2023-04-0510-238/+237
| | | | | | | | | | Fixing extra indentation, syntax issues, and formatting. Adapting too some snippet line highlights, and many other details. Pick-to: 6.5 Change-Id: Ife4eb5cec03577b2902d409b4007ae6d12141747 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: fix shiboken format inconsistenciesCristián Maureira-Fredes2023-04-041-75/+75
| | | | | | | | | | There were many unnecesary tabs, extra new lines, and missing grave accents in the shiboken documentation, that were generating a strange rendering. Pick-to: 6.5 Change-Id: Ic6040fe148a2a748c893e6577d336620e031d165 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Brush up the expenses tutorialFriedemann Kleint2023-04-0413-324/+168
| | | | | | | | | | | | | | | The snippet line numbers were not correct after the license change. Take the opportunity to fix up the code: - Use super() - Use a QFormLayout for the input fields - Remove the Quit button, which duplicates the menu action - Streamline code Pick-to: 6.5 Fixes: PYSIDE-2277 Change-Id: Id295573dbaf07557ca356eff83f4913753efb174 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* docs: add extendedexplorer tutorialDennis Oberst2023-03-3033-0/+1732
| | | | | | | | | | | | | | Extended the filesystemexplorer example with interactive scheme switching and wrote a tutorial about it. This tutorial uses Qml features from 6.5. The tutorial is intended to provide users with an overview of how to create modern applications with PySide/QtQuick Pick-to: 6.5 Task-number: QTBUG-108289 Task-number: PYSIDE-2224 Change-Id: I114824680156d0eacbbfe3363c67d1d5784a2219 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: migrate to sphinx-design and update sphinxCristián Maureira-Fredes2023-03-171-121/+109
| | | | | | | | | | | | | | | | | | | | sphinx-panels is deprecated, and sphinx-design is the better replacement. This patch migrates everything we had in pyside and shiboken, which was useful to remove many CSS related hacks for things we were forcing before. The example gallery was also adapted to generate sphinx-design valid code. Additional adaptation to some examples and files were included as well, which improved the overall example experience. We used this to change to update sphinx as well, which before was not possible to update due to sphinx-panels. Fixes: PYSIDE-2244 Change-Id: Ia3f57f536591ea299bf87302e930203b64fafd7e Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: adjust usage of -uic and -rcc toolsCristián Maureira-Fredes2023-03-163-4/+4
| | | | | | | | | | We encourage people to use the option '-o' rather than '>' to avoid having output messages inside the generated file. Change-Id: Ie45303265c8f391c4e54e0e2af9d7e810a0797aa Pick-to: 6.2 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Add overviews from qtdoc to index pageFriedemann Kleint2023-02-221-0/+7
| | | | | | Task-number: PYSIDE-2225 Change-Id: I1ed36000a2d8685743725704ccd913147e5b98f4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: update versions and broken linksCristián Maureira-Fredes2023-02-162-3/+3
| | | | | | | Pick-to: 6.2 6.4 Change-Id: Ib6223ac742b7c7777d2b6110a395b508e5031a75 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* doc: fix broken gettingstarted linksCristián Maureira-Fredes2022-12-151-1/+1
| | | | | | Change-Id: I9471df621335ea1ecc967109ec8a5642bc85b0cf Pick-to: 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Add some hints for debug builds on WindowsFriedemann Kleint2022-12-121-0/+2
| | | | | | | Pick-to: 6.4 6.2 Change-Id: Ice4a0915cc5d53bf62d25f082318cff95c782856 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: update dataviz URL to download all the codeCristián Maureira-Fredes2022-11-251-1/+2
| | | | | | | | | | The file was removed, and it's better to provide a direct URL to the repo location Pick-to: 6.4 Change-Id: I78a4c2fd71b6f9a8032c16541871584bf9327ca3 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: move the FAQ out of tutorialsCristián Maureira-Fredes2022-11-2511-695/+0
| | | | | | | | | | | | After feedback that the common questions are not really tutorials, they are now moved at the end of the 'quickstart' page, so people can understand concepts and the scope of the project just after doing a hello-world application. Pick-to: 6.4 Change-Id: Ib6757292ff3d30d560dd99d36a6a047653039c5d Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: order the sidebar contentCristián Maureira-Fredes2022-11-032-3/+3
| | | | | | | | | | | | | | As a quick-access to all the documentation, the sidebar of the documentation was a mix of topics without any logical order. Creating directories with an index.rst file, and putting the content on the right topic toctree allow us to have a more clear and simple general toc. Change-Id: I43af890ce988946ababcd575d431fc66704c3e85 Pick-to: 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Update documentationFriedemann Kleint2022-09-121-1/+1
| | | | | | | | | | - Use version 6.2 - Delete obsolete paragraphs - Fix some errors Pick-to: 6.3 6.2 Change-Id: I0c86f013fb3ad21a4cc7c5d490a9f129e80f3540 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix the modelview programming tutorialFriedemann Kleint2022-08-123-0/+305
| | | | | | | | | | | | | Add some documentation examples and snippets to fix most outstanding C++ to Python conversion errors. The rest looks roughly ok and could be improved by further fixing up the snippet conversion. Task-number: PYSIDE-1984 Pick-to: 6.3 6.2 Change-Id: I8c1bdcbc4a07847b2731ef7e2b9ba666cc00ccd6 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Update the VS Code debugging tutorial for WindowsAdrian Herrmann2022-08-092-31/+85
| | | | | | | | | | | Update the "Debugging PySide with VSCode" tutorial so it applies to Windows as well. Task-number: PYSIDE-2000 Pick-to: 6.2 6.3 Change-Id: I487534f3094e2b9a1c2b60733ffe599afe7b39b4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Fix Typo : PySide Debugging TutorialShyamnath Premnadh2022-07-071-1/+1
| | | | | | | | - CMAKE_BUILD_TYPE instead of MCAKE_BUILD_TYPE Pick-to: 6.2 6.3 Change-Id: I542d3828c6b2dad3fa5f48dbedfecf37910fcae8 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Remove left-over archive fileFriedemann Kleint2022-06-301-0/+0
| | | | | | | | Added by 25180730194bec25f915f32ab846ea583fb1493f. Pick-to: 6.3 6.2 Change-Id: Ib6440293f5193972cb5f10c71816b6e7189534a9 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: Fix line numbers in the porting tutorialFriedemann Kleint2022-06-291-3/+3
| | | | | | | | | | Fix warning: sources/pyside6/doc/tutorials/portingguide/chapter1/chapter1.rst.rst:51: WARNING: line number spec is out of range(1-113): '44-122' Amends 99d76b5e4e2397fcb4ddf45de91748ab1861f755. Change-Id: Ic2d30b4b6431bef7406763a27f124fccf30b6f7e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* docs: adapt snippets to new license rowsCristián Maureira-Fredes2022-06-2215-75/+75
| | | | | | | | | | The license headers are now a couple of lines compared to the previous 40 lines, so the snippets that select 'from which line' the code must be included needed some adaptation. Change-Id: Id8bb87d708cc7c9edadb1b8265cecf81bf0bf5ae Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Use SPDX license identifiersLucie Gérard2022-05-2752-2075/+104
| | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Task-number: QTBUG-67283 Change-Id: I065150015bdb84a3096b5b39c061cf0a20ab637d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: change http by httpsCristián Maureira-Fredes2022-04-0147-48/+48
| | | | | | Pick-to: 6.2 Change-Id: Id796694e947643152dc0d57dd760efb89ddd8f16 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Link the Tutorial from the Signal/Slot reference pagesFriedemann Kleint2022-03-231-0/+2
| | | | | | | Pick-to: 6.2 Fixes: PYSIDE-1863 Change-Id: I7bf2c04ad5a5ab7b5bb29b082ee9d3fbf3b51c2a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add constructor documentation to Signal/SlotFriedemann Kleint2022-03-141-0/+2
| | | | | | | | As a drive-by, rewrap some paragraphs. Pick-to: 6.2 Change-Id: Ia17c3937bb48a3fab5e573819b5f27b896199240 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Mention that .ui/.qml files should be passed to lupdateFriedemann Kleint2022-01-131-0/+10
| | | | | | | | Task-number: PYSIDE-1774 Task-number: PYSIDE-1717 Pick-to: 6.2 Change-Id: I7aa2a39e3d768fcbbec953720c8e89824df9f916 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix some doc warnings in the debugging tutorialFriedemann Kleint2022-01-062-4/+4
| | | | | | | | | | | | | | | | | | Fix: - sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst:2: WARNING: Title underline too short. - sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst:21: WARNING: Inline interpreted text or phrase reference start-string without end-string. Change the syntax highlighting to javascript, since json does not like the embedded comments of the MS-extended jsonc, fixing: sources/pyside6/doc/tutorials/debugging/vscode/vscode.rst:21: WARNING: Could not lex literal_block as "json". Highlighting skipped. sources/pyside6/doc/tutorials/debugging/vscode/vscode.rst:47: WARNING: Could not lex literal_block as "json". Highlighting skipped. Amends d727a69e2f58be167845b8179edf1735df6ccf1e. Pick-to: 6.2 Task-number: PYSIDE-841 Change-Id: I171c57e4a7f787559022fbbb14a7eb7bb9f1a91c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add Debugging TutorialShyamnath Premnadh2021-12-2312-0/+309
| | | | | | | | | | | | Add tutorial to debug C++ counterpart of PySide application. This commit provides general instructions to setup everything for debugging and debugging using either QtCreator/VSCode. Pick-to: 6.2 Task-number: PYSIDE-841 Change-Id: I6a95ab64507a304fc19a2cdcdf6d29b6c96cca03 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Fix most sphinx errors "Inline strong start-string without ↵Friedemann Kleint2021-11-231-1/+1
| | | | | | | | | | | | end-string." Ensure characters following a formatting end are escaped by adding handling and some RST manipulators to class TextStream. Task-number: PYSIDE-1112 Pick-to: 6.2 Change-Id: I167160cd18fd890d73e31738487d2c91e012196c Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: replace api module table with panelsCristián Maureira-Fredes2021-11-101-0/+1
| | | | | | | | | | This fix the warnings introduced by a previous change. Pick-to: 6.2 Change-Id: Ie25db8f8e466103487cda9ca4032bd75fab69e7b Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add a signals and slots tutorialFriedemann Kleint2021-10-073-0/+236
| | | | | | | Pick-to: 6.2 Task-number: PYSIDE-841 Change-Id: I7e78f97fed206f0722e50d967ec84800d3bef810 Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: fix warnings from rst filesCristián Maureira-Fredes2021-09-271-2/+2
| | | | | Change-Id: I97166f7e89c0365f425d1f8b0b840b7ef066d0d7 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: fix missing image in why qt for pythonCristián Maureira-Fredes2021-09-271-0/+3
| | | | | Change-Id: I001f8e1ed3c40e4be8eebebe6a44a1c0c9c869a9 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* tutorials: update datavisualization and expensesCristián Maureira-Fredes2021-09-2227-76/+141
| | | | | | | | | | | | | | | These tutorials were removed due to QtCharts not being available, additionally due to the QtCharts namespace changes the code needed to be adjusted. Adding panels for the tutorials to display as cards instead of a list, and creating a new section called 'General Applications'. Task-number: PYSIDE-841 Change-Id: I18fbce3fd48ed35013bcc82013ffc6e06f005b03 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: update qml tutorialsCristián Maureira-Fredes2021-09-178-69/+102
| | | | | | | | | | | | - Add screenshot and updates to the 'first qml application' - Update 'context properties' for 'python-qml interaction' tutorial - Remove the 'Real use-cases' subsection - Update the snippets from QML application tutorial - Update the QML SQL integration tutorial Change-Id: I9c6a1bedb66b130e9c28d340b236e778f7c109b8 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* PySide6: Document QUiLoader restriction wrt signal/slot connectionsFriedemann Kleint2021-09-151-0/+7
| | | | | | | Fixes: PYSIDE-1659 Pick-to: 6.1 5.15 Change-Id: I9025e8454d7153faec8b49f0ae02bf175dae3fd8 Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: improve tutorials and stylingCristián Maureira-Fredes2021-09-0923-3/+350
| | | | | | | | | | | | | - Creating screenshots for tutorials. - Add gallery style for tutorials. - Add corporate Icons to the frontpage. - tools: Reduce example long names in the gallery. - videos: new order using panels - Add tutorial about "Why Qt for Python" Change-Id: I3ba50f74998399a47b4a34c1de029f3b746aa1e2 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* qml: replace context properties and code updatesCristián Maureira-Fredes2021-07-217-62/+87
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Most of the qml code in the repository was outdated, and followed bad practices, like context properties. Complementary, after the major updates for Qt6 most of the code was not relying on the new ways of register types (singletons, and using the decorator QmlElement). Drop the context property usage in the following examples: - signals/qmltopy1 - signals/qmltopy2 - signals/pytoqml2 - usingmodel - quickcontrols2/gallery - textproperties Additionally: - all the tests related to context properties - tutorials/qmlapp - tutorials/qmlsqlintegration - Removing 'scrolling' example - Fixing some flake8 warnings Change-Id: I649248c0149876bf2bf94e78e27cef7110f42f1d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Keith Kyzivat <keith.kyzivat@qt.io>
* Add a linguist exampleFriedemann Kleint2021-07-071-0/+82
| | | | | | | | Add an example and a tutorial section. Task-number: PYSIDE-1252 Change-Id: Ib0f1399abe9b0eb832c0202f54cb83dfad870d17 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* pathlib: support all cases which are found in the examplesChristian Tismer2021-07-063-3/+3
| | | | | | | | | | | | Wherever possible/useful, os.fspath was removed and the according pathlike modification inserted. This is still not the awaited end of the conversion, but a good step forward. Task-number: PYSIDE-1499 Pick-to: 6.1 Change-Id: I0a22ddeec06ada05dc4a97ed104d06f5f1bbf472 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add a gettext exampleFriedemann Kleint2021-07-062-0/+120
| | | | | | | | | Add a small example along with a German translation using gettext. Add a tutorial. Pick-to: 6.1 Change-Id: I254a5a66521ecc2827a5811469d9d21360f99b81 Reviewed-by: Christian Tismer <tismer@stackless.com>
* pathlib: extend QUrl.fromFilePath to support os.PathLikeChristian Tismer2021-07-021-1/+1
| | | | | | | | | | | [ChangeLog][PySide6] The function QUrl.fromFilePath supports now the os.PathLike structure in addition to string arguments. The new interface was applied, everywhere. Change-Id: I2d888383c54b7f964e448d210264c7e902759f43 Pick-to: 6.1 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* PySide6: Update documentation on Qt Designer and resource filesFriedemann Kleint2021-06-283-15/+27
| | | | | | | | | Link from typesoffiles.rst to the tutorials and flesh them out a bit. Task-number: PYSIDE-1112 Pick-to: 6.1 Change-Id: I67fccb29d880bd2ba5af8e5dd77a4f6406ea55ad Reviewed-by: Christian Tismer <tismer@stackless.com>
* PySide6: Add some information on the toolsFriedemann Kleint2021-06-172-0/+4
| | | | | | Task-number: PYSIDE-1378 Change-Id: I9433fd3b1d4d09c6a7d961d67c103ccd651e5beb Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Purge remaining app.exec_()Friedemann Kleint2021-05-1735-41/+41
| | | | | | | | Add a porting note. Pick-to: 6.1 Change-Id: I4ccb1dc2a3a5925e55e94e7f3d23b1fb199afe4a Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add some hints for trouble-shooting the Qt Designer pluginFriedemann Kleint2021-05-071-0/+13
| | | | | | | Pick-to: 6.1 6.1.0 Task-number: PYSIDE-1455 Change-Id: I7bf6745801dc4747cb7f24144e197bd3059bd493 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add further documentation on the Qt Designer pluginFriedemann Kleint2021-02-231-16/+11
| | | | | | | | | | Document the QPy*Extension base classes and functions of QPyDesignerCustomWidgetCollection. Task-number: PYSIDE-1455 Change-Id: I3874058ed50475a418be3becbeb22ad94066dca5 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PySide6: Add a Designer pluginFriedemann Kleint2021-02-161-0/+88
| | | | | | | | | | | | | | Add a convencience class QPyDesignerCustomWidgetCollection to the Qt Designer module, which provides functions for registering widget types or adding QDesignerCustomWidgetInterface instances. A static instance of it is stored as a dynamic property on QCoreApplication, which is retrieved by a Qt Designer plugin, which provides the collection of widgets registered in Python. Task-number: PYSIDE-1455 Change-Id: If4055e6c9db6a03b32016b013a1130051bbd472a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-12 10:56:47 +0000