aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/developer
Commit message (Collapse)AuthorAgeFilesLines
* doc: Add documentation about type hintsEce Cinucen2025-08-012-0/+178
| | | | | | Pick-to: 6.9 Change-Id: I030593a9feed8a2f1eaa4c7f3e22f15ef9ccdb7e Reviewed-by: Shyamnath Premnadh <[email protected]>
* Add developer documentation on thread sanitizerFriedemann Kleint2025-07-241-0/+34
| | | | | | | | | Complements 7b8592161d6c4d63c511a352fdf25d49ab0a1906. Task-number: PYSIDE-2221 Change-Id: Iceef71b8cf9b85f9f41c91e34638184848d4f653 Reviewed-by: Shyamnath Premnadh <[email protected]> Reviewed-by: Ece Cinucen <[email protected]>
* Brush up developer documentation (extras.rst)Friedemann Kleint2025-07-241-4/+7
| | | | | | | Pick-to: 6.9 Change-Id: I5199c2780b108aa1dacb7a3f352e3e7a2f9220b3 Reviewed-by: Shyamnath Premnadh <[email protected]> Reviewed-by: Ece Cinucen <[email protected]>
* 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 <[email protected]> Reviewed-by: Brett Stottlemyer <[email protected]>
* 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 <[email protected]>
* Documentation: Add missing pagesFriedemann Kleint2024-12-171-2/+2
| | | | | | | | | | | | 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 <[email protected]>
* 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 <[email protected]> Reviewed-by: Cristian Maureira-Fredes <[email protected]>
* 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 <[email protected]>
* limited api: Remove PyCFunction_GET_FUNCTION, PyCFunction_GET_SELF, and ↵Cristián Maureira-Fredes2024-12-091-4/+0
| | | | | | | | | | PyCFunction_GET_FLAGS Removing old compatibility macros from the initial limited api implementation. Change-Id: I3044609ade36b5b378de05934eab8a098450f42f Reviewed-by: Friedemann Kleint <[email protected]>
* Raise Python version to 3.8Friedemann Kleint2024-12-031-1/+1
| | | | | | | | | | | | | | Fix some oversights of previous changes: - Bump limited API - Fix CMake files - Remove outdated version checks from Python code - Adapt some documentation Pick-to: 6.8 Task-number: PYSIDE-2943 Change-Id: Id8d9c4c6bb0629948de28beb3c4274991f84ff08 Reviewed-by: Cristian Maureira-Fredes <[email protected]>
* type hints: Use positional parameters according to PEP 570Christian Tismer2024-11-211-5/+7
| | | | | | | | | | | This change would have been very simple (basically one constant) if there were not mypy which needed more effort to stay correct. Change-Id: I464b0522f9d174c5a302f85caf2fcbe202dcaed2 Pick-to: 6.8 Fixes: PYSIDE-2624 Task-number: PYSIDE-2846 Reviewed-by: Friedemann Kleint <[email protected]>
* limited api: remove macro declaration from headerCristián Maureira-Fredes2024-11-201-19/+0
| | | | | | | | | | | | | This is a continuation of the previous patches that were replacing the usage of macros for: lists, tuple, bytes, and float in the code, by the equivalent functions. [ChangeLog][PySide6] For the limited api builds (wheels) PySide had in place aliases from Python macros to their function equivalent. This is now removed, in favor of using the functions directly. Change-Id: I838bebac80067e3094b2a0dfadd1614f9644f7ca Reviewed-by: Friedemann Kleint <[email protected]>
* limited api: Remove PyList_GET_ITEM, PyList_SET_ITEM and PyList_GET_SIZE macrosCristián Maureira-Fredes2024-11-081-8/+0
| | | | | | | | | Removing old compatibility macros for the initial limited api implementation. Change-Id: Iced149450bd9bda18e43ac0acea0061cdcdb211e Pick-to: 6.8 Reviewed-by: Friedemann Kleint <[email protected]>
* type hints: Add some mypy explanations to developer docsChristian Tismer2024-10-313-20/+224
| | | | | | | | | First attempt to explain a little how mypy errors were treated. Task-number: PYSIDE-2846 Change-Id: I13a0d2b8298d5fd1637d3bca9e2b979c7062b811 Pick-to: 6.8 6.8.0 Reviewed-by: Cristian Maureira-Fredes <[email protected]>
* Documentation: Remove example anchorsFriedemann Kleint2024-08-161-0/+4
| | | | | | | The example_gallery tools also adds anchors, use these instead. Change-Id: I488250fae608cf50804c3edfe0ec12d4aa08194a Reviewed-by: Cristian Maureira-Fredes <[email protected]>
* Docs: Fix sphinx warningsShyamnath Premnadh2024-08-161-2/+2
| | | | | | | - Mostly toctree warnings, missing file paths and indentation issues. Change-Id: I3531f3b7ab3341dd21955ffe73664916b81ecfa2 Reviewed-by: Cristian Maureira-Fredes <[email protected]>
* Documentation: Rearrange sectionsShyamnath Premnadh2024-08-121-1/+1
| | | | | | | | | | | | | | | | | | | | | - 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 <[email protected]> Reviewed-by: Cristian Maureira-Fredes <[email protected]>
* Add Signalmanager documentationFriedemann Kleint2024-07-292-0/+59
| | | | | | Task-number: PYSIDE-2810 Change-Id: Ibbad9d612a51a35e4b2f0c5eeb3a989d8495dd10 Reviewed-by: Christian Tismer <[email protected]>
* 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 <[email protected]>
* 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 <[email protected]>
* Tooling: Add pyside6-qsbShyamnath Premnadh2024-04-181-2/+4
| | | | | | | | | | | - 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 <[email protected]>
* Documentation: Add instructions for using address sanitizerFriedemann Kleint2024-04-181-0/+13
| | | | | | Pick-to: 6.7 Change-Id: I851ffc5a9d421bb3a227594db691f67694ca042a Reviewed-by: Adrian Herrmann <[email protected]>
* Documentation: Use single emphasis for Qt toolsFriedemann Kleint2024-03-252-5/+5
| | | | | | | | Do some minor corrections. Pick-to: 6.7 Change-Id: If5b3f451a7d4005521bc78bc9683bf7b449d02fc Reviewed-by: Shyamnath Premnadh <[email protected]>
* Docunentation: Add steps to bump the versionFriedemann Kleint2024-02-291-0/+11
| | | | | | Pick-to: 6.6 Change-Id: I870af04f6d5d515db8f0ff96a4ad6428b3fa6613 Reviewed-by: Adrian Herrmann <[email protected]>
* Add documentation on how to adapt to new Qt versionsFriedemann Kleint2024-01-292-0/+44
| | | | | | | | | As a drive by, add a comment about QT6_DECL_NEW_OVERLOAD_TAIL to the QtCore type system file. Pick-to: 6.6 Change-Id: Idf395158f955fb3114431a04542a26341f53a7af Reviewed-by: Christian Tismer <[email protected]>
* Document the lesser known aspects of adding modules/examplesFriedemann Kleint2024-01-252-4/+16
| | | | | | Pick-to: 6.6 Change-Id: Id3b7a411222808d7b783220dd6f383ad0de309dc Reviewed-by: Cristian Maureira-Fredes <[email protected]>
* doc: fix some issues found with rstcheckCristián Maureira-Fredes2024-01-083-2/+3
| | | | | | | | | | Checking the local rst files, we had some issues related to repeated links, bad syntax of code-blocks, invalid levels, etc. Pick-to: 6.6 Change-Id: I94d64d9cca5142833640f30299d1ad32b568f7ad Reviewed-by: Friedemann Kleint <[email protected]>
* Developer Documentation: Add documentation hintsFriedemann Kleint2023-08-042-0/+73
| | | | | | | | | | Move the sources/pyside6/doc/README.md to a new page of the Developer Documentation and prepend some information about fixing snippets/texts. Pick-to: 6.5 Change-Id: If80eaa34cce1c98f46dcd3102670ec61dd0ffbb0 Reviewed-by: Shyamnath Premnadh <[email protected]>
* PyEnum: Update docs and rename the optionChristian Tismer2023-06-161-3/+5
| | | | | | | | | | | | | The new Enum implementation can no longer be switched off. Individual features can still be deselected with the environment variable PYSIDE6_OPTION_PYTHON_ENUM which had the name PYSIDE63_OPTION_PYTHON_ENUM before. This change is meant for PySide 6.6 . Task-number: PYSIDE-1735 Change-Id: Iae5b7a9d42a0d7b005dbba20201a80713ef79be9 Reviewed-by: Friedemann Kleint <[email protected]>
* Developer docs: Add note about optimizing imagesFriedemann Kleint2023-06-071-0/+3
| | | | | | | Pick-to: 6.5 Change-Id: Ie3bbcdba4e600e98c2bd5658a25eacabb37c6b52 Reviewed-by: Shyamnath Premnadh <[email protected]> Reviewed-by: Adrian Herrmann <[email protected]>
* documentation: Update after removal of __signature__Christian Tismer2023-04-281-1/+2
| | | | | | | | | | | The __signature__ attribute was removed. The replacement is given by function `get_signature`. This change did not land in feature-motivation.rst . Change-Id: Ic559a6c080c68025de1c5da9fadab7086b639628 Pick-to: 6.5 Reviewed-by: Friedemann Kleint <[email protected]>
* example_gallery: Fix literalinclude for project filesFriedemann Kleint2023-04-281-0/+7
| | | | | | | | | | | | Make it possible to reference code snippets from the example by relative file names. This makes it possible to write tutorial examples. Pick-to: 6.5 Task-number: PYSIDE-1106 Change-Id: Ie95d69c3f98be239e210c9c32b8fc9fb484639f4 Reviewed-by: Keith Kyzivat <[email protected]> Reviewed-by: Shyamnath Premnadh <[email protected]>
* Tooling: Simplify adding new toolsShyamnath Premnadh2023-04-181-19/+27
| | | | | | | | | | | | - Amends a48de6afbf127831aa46c1c006d777861bbbe9cb - Simplify the developer doc for adding new tools - Make build_scripts/__init__.py the primary place to add new tools for the build process Pick-to: 6.5 Change-Id: I1e8bd9e069471bf51a186c067773d7fbc2588769 Reviewed-by: Christian Tismer <[email protected]> Reviewed-by: Friedemann Kleint <[email protected]>
* doc: add tools recommendations for examplesCristián Maureira-Fredes2023-04-071-1/+16
| | | | | | | | | | Including a reference to flake8 and ruff to find issues with the code styling of the new examples, and encouraging users to use isort to order imports. Change-Id: I128a0d2712d10f39a1debe49bfdb16f24690e493 Pick-to: 6.5 Reviewed-by: Friedemann Kleint <[email protected]>
* doc: fix issues with pyside rst filesCristián Maureira-Fredes2023-04-054-70/+48
| | | | | | | | | | 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 <[email protected]>
* Docs: Fix misplaced section in feature-motivation.rstFeRD (Frank Dana)2023-02-061-5/+5
| | | | | | | | | | | Commit 9b5fa60d1fed5025e97c393ba1bab80f81ba833a added the section "Using __feature__ with UIC files" to the doc, but mistakenly inserted it between the previous section and the code block which followed it. Change-Id: I56ae37bf3373c110b0f1e4bb342cd6df27b0d68c Reviewed-by: Christian Tismer <[email protected]> Reviewed-by: Friedemann Kleint <[email protected]>
* doc: fix build warningsCristián Maureira-Fredes2023-02-031-0/+1
| | | | | | | | | Issues were found related to images, indentation level, and old references. Pick-to: 6.4 Change-Id: Idb343d4b3660ec44148fffd2de978ea868c56e90 Reviewed-by: Friedemann Kleint <[email protected]>
* shiboken: optionally de-virtualize the Python filesChristian Tismer2023-01-171-0/+17
| | | | | | | | | | | | | | | | | | | | The Python files in Shiboken are completely virtualized. That means: There is no interaction with the external world that could create interferences. For debugging purposes or to modify the embedded files, it is anyway useful to have an option to materialize these files in the file system, again. We add an environment variable `SBK_EMBED` that explicitly unpacks the Python files (SBK_EMBED=0) or explicitly removes the unpacked files (SBK_EMBED=1). Without this variable, the state of embedding remains the same. Change-Id: I1081b0f910482fb4b80a02f72c6bcce060db38e6 Fixes: PYSIDE-1994 Reviewed-by: Cristian Maureira-Fredes <[email protected]>
* doc: fix broken gettingstarted linksCristián Maureira-Fredes2022-12-151-1/+1
| | | | | | Change-Id: I9471df621335ea1ecc967109ec8a5642bc85b0cf Pick-to: 6.4 Reviewed-by: Friedemann Kleint <[email protected]>
* Developer Documentation - Modify add qt wrapper toolShyamnath Premnadh2022-11-181-1/+1
| | | | | | | | - Instead of config.py the tool comes from __init__.py now Pick-to: 6.4 6.4.1 Change-Id: I58530d067c6b9fd238ad184b44cad710d2ff6801 Reviewed-by: Friedemann Kleint <[email protected]>
* doc: order the sidebar contentCristián Maureira-Fredes2022-11-035-72/+375
| | | | | | | | | | | | | | 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 <[email protected]>
* doc: Add section Developer NotesCristián Maureira-Fredes2022-11-017-61/+167
| | | | | | | | | | | | | Including an item on the main documentation page to list and include all the content already included in the 'developer' documentation directory. Some files were split to improve the readability and structure of the notes. Pick-to: 6.4 Change-Id: Iaf54858cfc902e290af7311106f82042351b9a17 Reviewed-by: Christian Tismer <[email protected]>
* Add a Developer HOWTOFriedemann Kleint2022-10-211-0/+87
| | | | | | | Pick-to: 6.4 Change-Id: Ie6e6f3a5446a080a2a33ba75f710f3fdd88a36cb Reviewed-by: Adrian Herrmann <[email protected]> Reviewed-by: Christian Tismer <[email protected]>
* PySide-doc: Create some developer doc about enum featuresChristian Tismer2022-10-181-0/+159
| | | | | | | | | | | This is the internal documentation of the flags that can control the enum behavior at startup of a script. Task-number: PYSIDE-1735 Change-Id: Ibe9653de04edf2b73ac199e2dad6f7ddf55716da Pick-to: 6.3 6.4 Reviewed-by: Adrian Herrmann <[email protected]> Reviewed-by: Venugopal Shivashankar <[email protected]>
* PySide-doc: Move the pep384impl_doc.rst into the PySide treeChristian Tismer2022-10-131-0/+704
| | | | | | | | | | | | | | | This document is there since a long time, but was never in the normal document tree. The moved document will reside under a "Notes for Developers" section. Please feel free to comment this old stuff, maybe something is no more true or superseded, and you will surely find some style flowers. Task-number: PYSIDE-560 Change-Id: I73c95721932d492159b81e4a2c013294de9f8c06 Pick-to: 6.3 6.4 Reviewed-by: Cristian Maureira-Fredes <[email protected]>
* PySide-doc: Move the signature_doc.rst into the PySide treeChristian Tismer2022-10-131-0/+376
This document is there since a long time, but was never in the normal document tree. The moved document will reside under a "Notes for Developers" section. Please feel free to comment this old stuff, maybe something is no more true or superseded, and you will surely find some style flowers. Task-number: PYSIDE-510 Change-Id: I4575ada5b3ef325f706bcba54a5bf608dade1f7b Pick-to: 6.3 6.4 Reviewed-by: Cristian Maureira-Fredes <[email protected]>
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-20 05:48:39 +0000