aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
Commit message (Collapse)AuthorAgeFilesLines
* Docs: VSCode Extension for PySide6HEADdevShyamnath Premnadh5 hours4-1/+117
| | | | | | | | | | - Docs for the `Qt Python` extension for Visual Studio Code and its features for PySide6 development. Pick-to: 6.10 Change-Id: I9dfc80b8dab651d3615fcdf4878c674222a74dee Reviewed-by: Ben Cho <ben.cho@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Update documentation on porting examplesFriedemann Kleint3 days1-2/+8
| | | | | | | | | List useful environment variables and remove the snake case point since it causes maintenance problems. Pick-to: 6.10 Change-Id: I5c3d5e182b471ab3983e3a124ad95389d0d9bc7f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix CMake 3.31.6 warningsFriedemann Kleint2025-10-171-3/+0
| | | | | | | | | | | | | | | Remove some superfluous parameters, fixing: CMake Warning (dev) at doc/CMakeLists.txt:218 (add_custom_command): The following keywords are not supported when using add_custom_command(TARGET): DEPENDS. CMake Warning (dev) at doc/CMakeLists.txt:252 (add_custom_command): Keyword WORKING_DIRECTORY requires a value, but none was given. Pick-to: 6.10 Change-Id: I8212fc29241d7843f0708bd91f79976b5890ea52 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* deployment-pyside6-android-deploy.rst: Fix spelling errorFriedemann Kleint2025-10-091-1/+1
| | | | | | | Pick-to: 6.10 6.8 Fixes: PYSIDE-3199 Change-Id: Ie77adfb731c5ce78e2587fdb08f339784561b07c Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Replace _PepUnicode_AsString() by PyUnicode_AsUTF8AndSize()Friedemann Kleint2025-09-181-4/+0
| | | | | | | | | [ChangeLog][shiboken6] The helper function _PepUnicode_AsString() has been removed. PyUnicode_AsUTF8AndSize() should be used instead. Task-number: PYSIDE-2786 Change-Id: I38f74cac80ac26cb91bab32012cbcb7c00e81140 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Use a collapse directive for the detailed class descriptionFriedemann Kleint2025-09-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | Traditionally, the class pages were modelled after the Qt C++ documentation. There was a brief description, ending with a reference to the detailed explanation, labelled "more..". While this actually works in sphinx, too, it starts to emit warnings about multiple definitions of the 'more' label. To fix this, introduce a sphinx collapsible directive, expanding to the detailed description. This however only works unless the detailed description has headlines (for example, for QObject). This creates a difference in that the detailed description is always initially hidden, but it is assumed that this is better for the common use case of browsing for a certain method. Pick-to: 6.10 6.9 6.8 Task-number: PYSIDE-1106 Change-Id: I152be16f2a5ee5ea8c2869396a207b554738b219 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add more information on changing the supported Python versionsFriedemann Kleint2025-09-151-2/+6
| | | | | | | | Complements f2654f600b4f2de5d95a98c09ef8f25634b08e81. Pick-to: 6.10 6.9 6.8 Change-Id: I99058eac157c67f86aecf1801157567320e07464 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add a tool to sync example filesFriedemann Kleint2025-09-151-0/+6
| | | | | | | Task-number: PYSIDE-2206 Pick-to: 6.10 Change-Id: I043f9a70bc576e35bf59357b7ffc9144295bbd68 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Move painteditem example around to be in sync with Qt C++Friedemann Kleint2025-09-151-1/+1
| | | | | | | | Pick-to: 6.10 Task-number: PYSIDE-2206 Change-Id: Iec8dbf9750adf87980bf272a14a78556f6445408 Reviewed-by: Ece Cinucen <ece.cinucen@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Add documentation on changing the supported Python versionsFriedemann Kleint2025-09-082-0/+60
| | | | | | Pick-to: 6.9 6.8 Change-Id: I0596aea0ad9b24683465a0054e7b302dc3904110 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Qt Design Studio tutorial: Fix documentation warningsFriedemann Kleint2025-09-051-3/+3
| | | | | | | | | | | | | | | Fix warnings: build/testenv610ia/build/pyside6/doc/base/tutorials/drumpad/index.md:73: WARNING: Include file '/data1/kleint/examples/tutorials/drumpad/final_project/Python/audio/audio_engine.py' not found or reading it failed build/testenv610ia/build/pyside6/doc/base/tutorials/drumpad/index.md:90: WARNING: Include file '/data1/kleint/examples/tutorials/drumpad/final_project/Python/audio/audio_files_model.py' not found or reading it failed build/testenv610ia/build/pyside6/doc/base/tutorials/drumpad/index.md:106: WARNING: Include file '/data1/kleint/examples/tutorials/drumpad/final_project/Python/audio/waveform_item.py' not found or reading it failed Amends efd8944b263a099e901ab588bc2d9357554f6ead. Change-Id: I00f98fc3292679347466e93cf513993eb0d48481 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Finance manager tutorial: Fix documentation warningFriedemann Kleint2025-09-051-0/+1
| | | | | | | | | Fix warning: sources/pyside6/doc/tutorials/finance_manager/part1/part1.md:354: WARNING: 'literalinclude': Has content, but none permitted [myst.directive_parse] Pick-to: 6.9 6.8 Change-Id: Icf3b5e56548d6e04ff19e50c0d463e917cb5d0c4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* type hints: Correct the type annotation of the notify parameter in ↵Ece Cinucen2025-08-281-1/+1
| | | | | | | | | | | | | QtCore.Property - The stub previously declared notify as Optional[Callable[[], None]], but at runtime notify must be a Signal (emitted when the property changes), never a Callable. - This caused errors in type checkers when passing a Signal to notify. - The annotation is now updated to Optional[Signal] Pick-to: 6.8 6.9 Fixes: PYSIDE-2308 Change-Id: Ie42e220c51dc0419524b9dc5696371f03c42cad9 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Design Studio Drumpad TutorialShyamnath Premnadh2025-08-041-2/+18
| | | | | | | | | - Amends efd8944b263a099e901ab588bc2d9357554f6ead to add a section on preliminary setup for running/deploying the application by running `pyside6-project` command. Change-Id: I2a0c96ede0e7100f54f7081b4dc7c04b7fc49e3c Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: Add documentation about type hintsEce Cinucen2025-08-012-0/+178
| | | | | | Pick-to: 6.9 Change-Id: I030593a9feed8a2f1eaa4c7f3e22f15ef9ccdb7e Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Update libclangShyamnath Premnadh2025-07-314-8/+10
| | | | | | | | - The current version mentioned in the documentation is outdated. - Updated to the latest version available. Change-Id: Ia25d8fd648ab437833ef87263d19badbd02b1885 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add Qt Design Studio tutorialJaime Resano2025-07-295-0/+218
| | | | | | | | | | | | Add a new Qt Design Studio tutorial to the documentation. The "Drumpad" example is added to the examples/tutorials folder, with both initial and final projects. The required Sounds are in a directory at the same level as both tutorials in order to reduce space. Change-Id: I59fdd662775ae48ee04e663d4aa5aa8cb333fcd5 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Add developer documentation on thread sanitizerFriedemann Kleint2025-07-241-0/+34
| | | | | | | | | Complements 7b8592161d6c4d63c511a352fdf25d49ab0a1906. Task-number: PYSIDE-2221 Change-Id: Iceef71b8cf9b85f9f41c91e34638184848d4f653 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Ece Cinucen <ece.cinucen@qt.io>
* Brush up developer documentation (extras.rst)Friedemann Kleint2025-07-241-4/+7
| | | | | | | Pick-to: 6.9 Change-Id: I5199c2780b108aa1dacb7a3f352e3e7a2f9220b3 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Ece Cinucen <ece.cinucen@qt.io>
* Desktop Deployment: Upgrade Nuitka to 2.7.11Shyamnath Premnadh2025-07-021-1/+1
| | | | | | | Pick-to: 6.8 6.9 Task-number: PYSIDE-1612 Change-Id: I63250605149c1b966017dc9bcb896925c59008a7 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add section about Thread affinity to signals_and_slots.rstFriedemann Kleint2025-06-301-0/+19
| | | | | | | | Pick-to: 6.9 Task-number: PYSIDE-3124 Change-Id: Ib795aca1a2ed75b31821a90c11ccb2bdfd08f9fc Reviewed-by: Ece Cinucen <ece.cinucen@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Remove hard-coded Q_OS_ defines from the CMake filesFriedemann Kleint2025-06-181-1/+1
| | | | | | | | | | | | | The hard-coded ENABLE_ and Q_OS_ do not work for cross-compiling. They are in fact a left-over from the pre-clang code parser. Clang is actually able to set the right defines when parsing qsystemdetection.h if the correct target is set. pyside6_global.h then no longer needs to be configured by CMake. Task-number: PYSIDE-3105 Change-Id: I640ab9e254b9ba35d5b7194001f5700911a8d421 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Document property/enum usage for Qt Widgets Designer custom widgetsFriedemann Kleint2025-06-171-1/+35
| | | | | | Task-number: PYSIDE-2840 Change-Id: I28ca7d163bd560ebb38fb693750e4c3e3b7de621 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Recommend using a Dev Drive on WindowsFriedemann Kleint2025-05-091-2/+9
| | | | | | Pick-to: 6.9 6.8 Change-Id: I2004096735d0a5852eeca23176e25ffd30a6fe4c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: Fix unclosed command formattingJaime Resano2025-04-041-1/+1
| | | | | | | | | | | | | | Currently there is an unclosed backtick (`) which shows the following error while building the documentation: sources\pyside6\doc\building_from_source/macOS.rst:77: WARNING: Inline interpreted text or phrase reference start-string without end-string. This patch fixes the issue. Pick-to: 6.9 Change-Id: I37ae34ca12e249e219ae765f121ee2f1bb2d371c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Desktop Deployment: Upgrade Nuitka to 2.6.8Shyamnath Premnadh2025-03-271-1/+1
| | | | | | | | | | - There were some updates with respect to PySide6 support - See changelog here: https://nuitka.net/changelog/Changelog.html#nuitka-release-2-6 Pick-to: 6.8 6.9 Task-number: PYSIDE-1612 Change-Id: If091184a2661f81d3d57342ba48edc35e748fc70 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Make Remote Objects usable beyond ModelsBrett Stottlemyer2025-03-132-0/+163
| | | | | | | | | | | | While present, the Qt Remote Objects bindings to Python have not been very useful. The only usable components were those based on QAbstractItemModel, due to the lack of a way to interpret .rep files from Python. This addresses that limitation. Fixes: PYSIDE-862 Change-Id: Ice57c0c64f11c3c7e74d50ce3c48617bd9b422a3 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Brett Stottlemyer <brett.stottlemyer@gmail.com>
* pyproject.toml: 4. Update pyside6-project documentationJaime Resano2025-03-123-26/+115
| | | | | | | | | | This patch modifies the existing pyside6-project documentation to include the new pyproject.toml file format. The .pyproject file format is announced as deprecated. Task-number: PYSIDE-2714 Change-Id: I1efd715babd3f288532b2bbc9d36897fcfc2e2a2 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: Fix the finance manager tutorial part 3Shyamnath Premnadh2025-03-121-5/+5
| | | | | | | | | | | - A description was wrong along with the emphasized code. This is now fixed. Pick-to: 6.8 Task-number: PYSIDE-2850 Change-Id: I44f2b4c9a89496a96c974e78611b30f4dcec6cf6 Reviewed-by: Ece Cinucen <ece.cinucen@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Fix the SQL tutorial to workFriedemann Kleint2025-02-134-8/+235
| | | | | | | Adapt to qtbase/d49a7412f55390e461773f4ffc36a82958d59b6d. Change-Id: I45065fd96a055f7966268ca14fd517f23798a923 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PySide6: Fix flake8 warnings in tutorialsFriedemann Kleint2025-02-1317-56/+55
| | | | | | | Pick-to: 6.8 Change-Id: I90fe3e854af90618cc2e450a473110306d651b4f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Ece Cinucen <ece.cinucen@qt.io>
* Documentation: Various fixesFriedemann Kleint2025-02-031-0/+1
| | | | | | | | | - Fix spelling and a misplaced anchor - Add note about enumerations Pick-to: 6.8 Change-Id: Iafb8eaff6140381aeaa705c0d164b72708a00154 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Fix installation steps in `Building from Source`Shyamnath Premnadh2025-01-203-29/+56
| | | | | | | | | | | - Uses `create_wheels.py` instead of `setup.py install` - Additionally, fix some spelling mistakes. Pick-to: 6.8 Change-Id: I79ccdc940295dc48650742af57f3abc1b3e2fd2b Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Ece Cinucen <ece.cinucen@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Tutorial: Deploy PySide6 Applications to Boot to QtShyamnath Premnadh2025-01-143-0/+185
| | | | | | | | | | - The tutorial explains how to deploy PySide6 applications to Boot to Qt OS on Raspberry Pi. Pick-to: 6.8 Change-Id: I0764c13ddc2ad47084821048e734c70ed6263b0c Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
* Documentation: Add `uv` to the building instructions for PySide6Shyamnath Premnadh2025-01-083-0/+66
| | | | | | | | | | - Add `uv` to the building instructions for PySide6, to make it easier for users to build PySide6. Pick-to: 6.8 Change-Id: I95708b5f8049ddc1f94ff7dd9d9a8b1cca4d2ce3 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Remove unnecessary use of 'object' in class constructionremoteobjectsdevCristián Maureira-Fredes2024-12-181-1/+1
| | | | | | | | | | | Considering we are not compatible with Python 2 anymore, we can drop the 'object' explicit inheritance in the class declaration. Pick-to: 6.8 Change-Id: Iac3a95aa9721c3ff1a755f457c0936ca157a8470 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Fix some flake8 errors in tests/examplesFriedemann Kleint2024-12-173-10/+4
| | | | | | | | As unearthed by the whitespace change. Pick-to: 6.8 Change-Id: I58c1a38c3c4a9c91719131d7950950ddf475872b Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add missing pagesFriedemann Kleint2024-12-172-2/+105
| | | | | | | | | | | | Add pages referenced from the overviews-main page and various module pages. Do a scan and add all (non-class reference) documents found except qtcore/qtdoc (too many) and deprecated modules. As a drive-by, developer the documentation. Pick-to: 6.8 Change-Id: Ibe16ff70b627274fbbbffeb93030ddea230295a8 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Fix broken link of the Qt overviews from the Tutorials pageFriedemann Kleint2024-12-171-1/+1
| | | | | | | | | Fix the link to the qtdoc-overviews-main.rst page introduced by 5cd44e96cee2e8fc105372b5234b0682a7bcc012. Pick-to: 6.8 Change-Id: I8d48687e9703b2df52d41ca5607a9e81491910bc Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: use footer instead of body for hover textCristián Maureira-Fredes2024-12-161-2/+2
| | | | | | | Pick-to: 6.8 Change-Id: Ia185a68fe276c9b83bd47fdb2b964d22bee5e382 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Fix some warningsFriedemann Kleint2024-12-162-3/+3
| | | | | | Pick-to: 6.8 Change-Id: I8d370d76264884924136879238a5bffef489c19e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Update QtQml/QtQuick modulesFriedemann Kleint2024-12-133-58/+100
| | | | | | | Task-number: PYSIDE-1106 Pick-to: 6.8 Change-Id: If09bf185c5fa23c2866bab23c7bd9570828000c1 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* shiboken6/Documentation: Prominently display QML typesFriedemann Kleint2024-12-1310-19/+1
| | | | | | | | | | | | | | | | | | | Previously the link to the QML types list (Qt web documentation) was automatically inserted into the last paragraph of the module description. This only had an effect when no PySide module description was present. Otherwise, it had to be manually added to the module description which was overlooked for some modules. To fix this, extend the module documentation obtained from the doc parsers by the URL to page and format it as a separate section preceding the class list. Remove the QML types from the PySide module descriptions. Pick-to: 6.8 Task-number: PYSIDE-1106 Change-Id: I0b107a81b239405c0258ecff924aef87472f13b0 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Developer documentation: Describe how to adapt generated Qt documentation to ↵Friedemann Kleint2024-12-132-1/+9
| | | | | | | | | | PySide Task-number: PYSIDE-1106 Pick-to: 6.8 Change-Id: Ia13545f935dc895da069df45c5ac3fa8cdf77a9f Reviewed-by: Ece Cinucen <ece.cinucen@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix trailing empty linesFriedemann Kleint2024-12-1324-25/+0
| | | | | | Pick-to: 6.8 Change-Id: I1a5964463f703ade0657816cb974206355a5ae5b Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Update basic module pagesFriedemann Kleint2024-12-113-29/+7
| | | | | | | | | | - QtCore: Add IPC and permissions - QtGui: Remove section on Vulkan as there are no bindings Task-number: PYSIDE-1106 Pick-to: 6.8 Change-Id: Iad520387062b81b8b3be0c2c875fce674788283d Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: adapt example card hover colorCristián Maureira-Fredes2024-12-102-5/+9
| | | | | | | | Using a colorscheme for light mode. Pick-to: 6.8 Change-Id: I323517140e4cd637883dca7b7597b477085591d5 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Add groupsFriedemann Kleint2024-12-107-14/+52
| | | | | | | | | | | | | | There are some special WebXML pages indicated by a <group> element that contain lists of classes with brief suitable for a "class list by function" section. Generate them to a separate directory for clarity and add them to the module pages. Task-number: PYSIDE-1106 Pick-to: 6.8 Change-Id: I4e2d0ef8c626502230078415a24547cd80c95bd9 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Fix tutorial referencesFriedemann Kleint2024-12-1015-20/+20
| | | | | | | | Amends d2318d7aab3616df6e589b6337d2c2b8cd6e1909. Pick-to: 6.8 Change-Id: Ibb61ad87b76a7432d2f9917dc36b88d62fe27b59 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Developer Documentation: Improve sections on additional documentation filesFriedemann Kleint2024-12-101-2/+12
| | | | | | | Task-number: PYSIDE-1106 Pick-to: 6.8 Change-Id: Ib24b7c1e2a9c496f037013792e66f260631533a9 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-28 15:17:00 +0000