aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* Add missing entries for QtGraphsWidgetsFriedemann Kleint2024-09-261-0/+4
| | | | | | | | | | - Add QtGraphsWidgets to README.pyside6_addons.md, fixing: Warning: the following modules are not in READMEs : {'QtGraphsWidgets'} - Add to to documentation index page. Task-number: PYSIDE-2620 Change-Id: Ida8964f852ae1e9869524ac59a50595b7ee59bb9 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Update module documentation for 6.7Friedemann Kleint2024-09-261-91/+90
| | | | | | | | | Fix titles and wording according to qtdoc..qtmodules.qdoc. Pick-to: 6.7 Task-number: PYSIDE-1112 Change-Id: Icffc619bcbdf8815c72cc06d18cf2e832e11dfa2 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Complete module documentation for 6.7Friedemann Kleint2024-09-265-0/+31
| | | | | | | | | | Add missing modules to the index page and add missing qdocconf files. Pick-to: 6.7 Task-number: PYSIDE-1112 Change-Id: Ide552aae911af86dea444733acf5fd3c00d8b899 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Remove C++ example documents from the additional pages listFriedemann Kleint2024-09-251-242/+0
| | | | | | | Pick-to: 6.7 Task-number: PYSIDE-1112 Change-Id: Id08a4c204294078be739ee9ee39770791d7f3f65 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Release NotesShyamnath Premnadh2024-09-191-0/+1
| | | | | | | | | | | | | - Introduces a new section in the navigation pane called "Release Notes" with subpages for PySide6, Shiboken6, PySide2, and Shiboken2. - The .md files are auto-generated by the script `tools/release_notes/main.py` and created in the directory `sources/pyside6/doc/release_notes/`. Fixes: PYSIDE-2853 Change-Id: I6def8b526f11a638581f29798dd6917cd435d19c Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Tooling: Add pyside6-svgtoqml toolShyamnath Premnadh2024-09-052-0/+22
| | | | | | Task-number: PYSIDE-2620 Change-Id: I0627c35162d37a9fa4fdb716235aacd15cdfb698 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Adapt paths for 6.8Friedemann Kleint2024-09-052-2/+2
| | | | | | | | | Adapt to qttools/c51980bb0d9658f2ade4de1900d07b08e88cb52d. Task-number: QTBUG-77650 Task-number: PYSIDE-2620 Change-Id: Icc083c9b3d768093f45caa5d7a3c54aec5eb2d4f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Desktop Deployment: Upgrade Nuitka to version 2.4.8Shyamnath Premnadh2024-08-301-1/+1
| | | | | | | Pick-to: 6.7 Task-number: PYSIDE-1612 Change-Id: I001f0f446d41330e1ef0a798c82297a0e7c47021 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: improve a bit the gettingstarted pageCristián Maureira-Fredes2024-08-284-31/+74
| | | | | | | | | | | | | | | Add explanation of Qt Widgets and Qt Quick, remove outdated information, and move the notes around where they make more sense. Add a banner for both technologies, and adding a screenshot of the Quick example. At the end, add a section to point the readers to the Examples and Tutorials sections. Change-Id: Ie3b1856b7150a83633f9747a22057d902fb44b48 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Remove example anchorsFriedemann Kleint2024-08-169-10/+14
| | | | | | | The example_gallery tools also adds anchors, use these instead. Change-Id: I488250fae608cf50804c3edfe0ec12d4aa08194a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: Fix sphinx warningsShyamnath Premnadh2024-08-163-3/+25
| | | | | | | - Mostly toctree warnings, missing file paths and indentation issues. Change-Id: I3531f3b7ab3341dd21955ffe73664916b81ecfa2 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: Fix broken links from base documentationShyamnath Premnadh2024-08-1613-32/+31
| | | | | | | | - Many https links and sphinx references which were broken have been fixed. Change-Id: Ia10a44bbbbe4ed7e761c72042b45a46030d02186 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: Update tutorial to use sphinx referencesShyamnath Premnadh2024-08-1526-22/+100
| | | | | | | | - Changed relative paths to use sphinx references. Task-number: PYSIDE-2837 Change-Id: Ia581af3820650ea35b675a1b360779bcaabd84bb Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: Find broken_linksShyamnath Premnadh2024-08-141-0/+7
| | | | | | | | | | | | | - Adds a new script that find the broken sphinx links and writes them into broken_links.json file. This is to be run after running sphinx-build with linkcheck, which will generate a output.json file with the status of all the links in the documentation. - Modified conf.py.in to ignore relative paths when runnning sphinx-build with linkcheck. Task-number: PYSIDE-2837 Change-Id: If2437049abc344ad942814a2304c88c4ef7b0c3f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: Use sphinx reference in gettingstarted.rstShyamnath Premnadh2024-08-141-6/+12
| | | | | | | | | | - update relative paths to use sphinx cross references. This ensures more robust documentation which is easier to maintain and these cross references can be reused. Task-number: PYSIDE-2837 Change-Id: I027073793f8344e0e0599d0441449833d536cdcc Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Docs: Add html redirectsShyamnath Premnadh2024-08-141-1/+12
| | | | | | | | | | | | | - Since some .rst folders were renamed and reaaranged, this broke some existing links i.e. quickstart.html does not exist anymore since it was renamed to gettingstarted.html - This patch establishes redirects so that the old changed html links still exists and redirect to the new links. For this a new dependency of sphinx_reredirects is added. Task-number: PYSIDE-2837 Change-Id: I7af4a1ffef174b06fd8cb439ad1ccf52754c744d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Rearrange sectionsShyamnath Premnadh2024-08-1215-46/+43
| | | | | | | | | | | | | | | | | | | | | - Rename 'Quick Start' to 'Getting Started'. Also, update the links accordingly. - The page 'Getting Started' is a building from source page. Hence renamed it accordingly with 3 sections - Linux, macOS and Windows. Each sections contains the steps to build from source for the specific platform. - Move 'Package Details' into the main table of contents - Move 'Porting from PySide2 to PySide6' into the 'Getting Started' section. - Additionally, fix the links accordingly and also fix some broken links - Additionally, increase the minumum Python version from 3.7 to 3.8 in the Getting Started section. Task-number: PYSIDE-2833 Task-number: PYSIDE-2837 Change-Id: I07f35dbe583533ff122f6ecb4deeb9c95389b3d1 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix license of the 'QML, SQL and PySide Integration Tutorial' tutorialFriedemann Kleint2024-08-123-3/+3
| | | | | | Pick-to: 6.7 6.5 Change-Id: I4afdce644ad932eab0bdf083c52940183f5b2bd3 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Brush up the 'QML, SQL and PySide Integration Tutorial' tutorialFriedemann Kleint2024-08-095-56/+41
| | | | | | | | | | | | | | | - Use loadFromModule(). - Fix the QML code to work - Remove SqlConversationModel.setRecipient() which is not used and builds an SQL statement by adding up string values. - Fix SqlConversationModel.roleNames() - Use QStandardPaths.writableLocation() instead of the current directory for the database and give it a proper name. Pick-to: 6.7 Task-number: PYSIDE-2833 Change-Id: Ib1d66abd2a01dc11f608311542a6e090232a04db Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Rewrite 'QML Application' tutorial to use loadFromModule()Friedemann Kleint2024-08-095-26/+29
| | | | | | | Pick-to: 6.7 Task-number: PYSIDE-2833 Change-Id: I8c4e9af9fe46cdd57f3fba65f8d9200512addea0 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Rewrite 'QML Integration' to use loadFromModule()Friedemann Kleint2024-08-084-19/+26
| | | | | | | | | | | As a drive-by, change the resource file name to the naming convention used by pyside6-project and fix some snippet lines. Pick-to: 6.7 Task-number: PYSIDE-2833 Change-Id: Id73b0584e45a58f20eb1a53892943119fe4db6a4 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Rewrite 'Quick start' to use loadFromModule()Friedemann Kleint2024-08-081-10/+17
| | | | | | | | Pick-to: 6.7 Task-number: PYSIDE-2833 Change-Id: I757fe6884a11454aa10d80248e78008807099160 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Documentation: Rewrite 'Your First QtQuick/QML Application' to use ↵Friedemann Kleint2024-08-081-11/+21
| | | | | | | | | loadFromModule() Pick-to: 6.7 Task-number: PYSIDE-2833 Change-Id: I4cf5d951a34699870251ffae3f9d0d72534d12a6 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Python-QML integration tutorial: Streamline Python codeFriedemann Kleint2024-08-052-25/+14
| | | | | | | | | | In the emphasized lines, fix an offset introduced by 50061290756323ff339bd0473e67117c8191d130. Pick-to: 6.7 Task-number: PYSIDE-2833 Change-Id: I4ea1eb6b520179c0d425bdb74eaae7663ce89125 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Deployment Documentation: Remove non-relevant sectionShyamnath Premnadh2024-08-011-4/+0
| | | | | | | | | | | - With e3ca9d63fd21867ad974928162a62832b36f807d, the section in the documentation is not relevant anymore since 'site-packages' is always ignored. Pick-to: 6.7 Task-number: PYSIDE-1612 Change-Id: Ia9a4c0f9b9143febdd2e92fcc3f3df3d23e6be0c Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Update modules.rstShyamnath Premnadh2024-08-011-3/+4
| | | | | | | | | - Move WebView up to resemble the source tree in pyside-setup. Task-number: PYSIDE-2825 Pick-to: 6.5 6.7 Change-Id: I2f68cc0ea9fbd77b0c318d86aff21ad5fd1ff6f4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add QtWebViewShyamnath Premnadh2024-07-312-0/+29
| | | | | | | | | [ChangeLog][PySide6] QtWebView has been added. Pick-to: 6.5 6.7 Task-number: PYSIDE-2825 Change-Id: I4617cb6b170b37c232ba55aa8be374f150604105 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Update the .qrc tutorialFriedemann Kleint2024-07-291-51/+52
| | | | | | | | | | It describes modifying the QtMultimedia player example which has changed over time. Fixes: PYSIDE-2828 Pick-to: 6.7 Change-Id: I016d28185790bbd05b3bbbdc83e254c94390bd9a Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add Signalmanager documentationFriedemann Kleint2024-07-292-0/+59
| | | | | | Task-number: PYSIDE-2810 Change-Id: Ibbad9d612a51a35e4b2f0c5eeb3a989d8495dd10 Reviewed-by: Christian Tismer <tismer@stackless.com>
* QtAsyncio: Add diagram about coroutinesAdrian Herrmann2024-07-192-6/+6
| | | | | | | | | | Add a diagram that explains coroutines to the QtAsyncio documentation instead of just linking readers to the YouTube video. Pick-to: 6.7 Task-number: PYSIDE-769 Change-Id: I33cb381958313ce1ce2c01eae10eca073761af85 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* QtAsyncio: Add developer notesAdrian Herrmann2024-07-192-0/+68
| | | | | | | | | | Add a few developer notes for QtAsyncio to our corresponding docs section. Pick-to: 6.7 Task-number: PYSIDE-769 Change-Id: I33cf5e1580fc93c9c90fd4e9573ad6c08d13ef13 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* QtAsyncio: Remove application arg from loop policyAdrian Herrmann2024-06-271-0/+3
| | | | | | | | | | | | | Remove the optional application argument from the constructor of QAsyncioEventLoopPolicy, as it is unnecessary. If a QCoreApplication or other type of qApp was created outside of QtAsyncio, it will always be retrieved by QCoreApplication.instance(), and therefore passing it as an argument makes little sense. Task-number: PYSIDE-769 Change-Id: Iac7a913a1c9d6ebbb0984fe11f8b5cda955baab1 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Desktop Deployment: Update Nuitka to 2.3.7Shyamnath Premnadh2024-06-261-1/+1
| | | | | | | | | | | | - Fixes sporadic crashes with Python 3.12 - Supports Numpy 2.0. This is not relevant for us currently, but it's good to have the latest version. Pick-to: 6.7 Fixes: PYSIDE-2781 Task-number: PYSIDE-1612 Change-Id: I96a437795018792906ba6cf44e6466dacc154dbf Reviewed-by: Christian Tismer <tismer@stackless.com>
* Python-3.10: Allow the new syntax for Python 3.9Christian Tismer2024-06-2054-0/+54
| | | | | | | | Add a future statement to all Python source files. Task-number: PYSIDE-2786 Change-Id: Icd6688c7795a9e16fdcaa829686d57792df27690 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Fix some documentation warnings and broken linksFriedemann Kleint2024-06-172-11/+11
| | | | | | Pick-to: 6.7 Change-Id: I5fbc1be390c7d24ef7f204721cd060e5d61c88e0 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Nuitka Deployment Doc - remove non-relevant sectionShyamnath Premnadh2024-06-171-13/+0
| | | | | | | | | - Not relevant with the latest Nuitka version that we use with pyside6-deploy Pick-to: 6.7 6.5 6.2 Change-Id: Id3e9cc5bcad678cb00a1b6049c740c5e321fbdde Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Deployment Docs: Add instructions to generate a bug reportShyamnath Premnadh2024-06-171-0/+26
| | | | | | | | | | - Additionally, remove some comments from default.spec that are not relevant anymore. Pick-to: 6.7 Task-number: PYSIDE-1612 Change-Id: Iea2fed95507b6e649285e409cf8678287bf15a56 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Desktop Deployment: Update Nuitka to 2.3.2Shyamnath Premnadh2024-06-111-0/+3
| | | | | | | | | | - Full support for Python 3.12 - Experiemental support for Python 3.13 Pick-to: 6.7 Task-number: PYSIDE-1612 Change-Id: Ib4699351ec4105de756b4ac16cd7b3a49054a614 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Desktop Deployment: Enable Nuitka --standalone modeShyamnath Premnadh2024-06-101-0/+6
| | | | | | | | | | | | | - enables the standalone mode of Nuitka for pyside6-deploy - the mode can be set either through the command line or the config file - adapt tests - update documentation Pick-to: 6.7 Fixes: PYSIDE-2622 Task-number: PYSIDE-1612 Change-Id: I5a10c857d3e79174d2643139eb2e4f7b5e10d955 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Update versions for Qt 6.8Friedemann Kleint2024-05-284-22/+34
| | | | | | Task-number: PYSIDE-2620 Change-Id: Iff5ac3c8281893adfa0ba3cbd64936fd7c4d6257 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation/QRC tutorial: Fix error in .qrc file snippetFriedemann Kleint2024-04-251-1/+0
| | | | | | | Pick-to: 6.7 6.5 Fixes: PYSIDE-2700 Change-Id: Icc1085cb51508cce35f0722219c9ae395f0b7bc5 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: Add QtQml.ListPropertyFriedemann Kleint2024-04-231-0/+24
| | | | | | | Pick-to: 6.7 Task-number: PYSIDE-2698 Change-Id: If9b9af49bb351fcb4e2355277ff84bd0936b5033 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Fix ClassInfo to be a proper decoratorFriedemann Kleint2024-04-221-7/+5
| | | | | | | Pick-to: 6.7 Task-number: PYSIDE-1106 Change-Id: I298769db5455368fca6890571546d4cf74ace957 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: Fix change describing address sanitizer usageFriedemann Kleint2024-04-191-1/+1
| | | | | | | | Amends 83a93d243dbc1ef6679ee8ac3a35184a6edc43d9. Pick-to: 6.7 Change-Id: Iedb3f4623b3ce487e750b5eacfa42c0771d4f7cc Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Tooling: Add pyside6-balsamuiShyamnath Premnadh2024-04-193-0/+28
| | | | | | | | | | - Add documentation for the tool - Add a screenshot of the tool Pick-to: 6.7 6.6 6.5 Task-number: PYSIDE-2629 Change-Id: I63d1d7e65d92ec37012ce40bb319dfeef9c9695b Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Tooling: add pyside6-balsamShyamnath Premnadh2024-04-182-1/+74
| | | | | | | | | - Also add the relevant documentation Pick-to: 6.7 6.6 6.5 Task-number: PYSIDE-2629 Change-Id: Ic2e7798a5f0ff7015cb87089dda2420ed6327ca2 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Tooling: Add pyside6-qsbShyamnath Premnadh2024-04-183-2/+56
| | | | | | | | | | | - Analogous to the qsb tool in Qt - Add pyside6-qsb tool to the documentation - Update developer documentation Pick-to: 6.7 6.6 6.5 Task-number: PYSIDE-2629 Change-Id: I93058ebb2864491e951f4f828d703d8893fbcbe7 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Add instructions for using address sanitizerFriedemann Kleint2024-04-181-0/+13
| | | | | | Pick-to: 6.7 Change-Id: I851ffc5a9d421bb3a227594db691f67694ca042a Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: Fix warning about ambiguous link to APIFriedemann Kleint2024-04-181-1/+1
| | | | | | | | | | | | | Use "pyside-api" as in api.rst, fixing: index.rst 102 WARNING: more than one target found for 'any' cross-reference 'api': could be :doc:`API Docs` or :py:meth:`PySide6.Qt3DRender.QGraphicsApiFilter.api` or :py:meth:`PySide6.Qt3DRender.QRenderCapabilities.api` or :py:meth:`PySide6.QtWidgets.QRhiWidget.api` Pick-to: 6.7 6.5 Change-Id: I813ab96bc5afb88e8a3e4dd936bbcd2c80b189c5 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation/Tools: Fix links to pyside6-lrelease, pyside6-lupdateFriedemann Kleint2024-04-081-2/+2
| | | | | | | | Amends d1e268df8406ed1c1d94b95511d3f61a3156d8ed. Pick-to: 6.7 Change-Id: Ie6653aaac127bdd7909f9c4825f4aa7f223e5260 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-14 14:10:22 +0000