aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* 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>
* 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 <Friedemann.Kleint@qt.io>
* Documentation/example_gallery: add card description hoverCristián Maureira-Fredes2024-12-091-11/+49
| | | | | | | | | | | | | - Adding the first paragraph (as much as possible) when the example card is hovered, and use the example headline as the title of the card. - Amends 133e8005def4314320062a9a36d950b8692e6f35 by removing the custom html tag and also merging '.sd-card:hover' into '.sd-card-hover:hover' to avoid duplication. Change-Id: I4edf96a5e61138c88a421e70f16ef9bfe4b4e04d Pick-to: 6.8 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation/example gallery: Handle tutorialsFriedemann Kleint2024-12-061-0/+23
| | | | | | | | | | | | | | | - Add the tutorial title to the example data struct and sort them to the front. - The examples under a module which are tutorials are organized under separate subtitles under the module name. - Change the grid layout for the examples and add a hover effect to the grid. Pick-to: 6.8 Task-number: PYSIDE-1106 Change-Id: I4196667404b9ff27851c2dad198b22c673de9bf9 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Raise Python version to 3.9Friedemann Kleint2024-12-041-1/+1
| | | | | | | Amends 262e2a6c2742eb9bb0887ae5cb7c2fb0a975f373. Change-Id: I9bb17b0ed53982fccacbef5b78687491899c3f06 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Raise Python version to 3.8Friedemann Kleint2024-12-033-5/+5
| | | | | | | | | | | | | | 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 <cristian.maureira-fredes@qt.io>
* PySide: Fix some missing documentationFriedemann Kleint2024-11-282-0/+5
| | | | | | | | | | | | | | | | | Add a missing docconf files: - QtWebView - QtStateMachine Fix documentation of QtPdfWidgets (point to QtPdf). Adds documentation Qt::mightBeRichText and Qt::convertFromPlainText (namespace "Qt"/QtGui). Pick-to: 6.8 Task-number: PYSIDE-2918 Task-number: PYSIDE-1106 Change-Id: I4eccaa20cfe82c2ec44cdbef6ec091d4592c0699 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Desktop Deployment: Upgrade Nuitka to 2.5.1Shyamnath Premnadh2024-11-271-1/+1
| | | | | | | | | | | | | | - Nuitka 2.5.1 imposes strict checking for the Qt plugins included through the --include-qt-plugins option by checking if the plugin actually exists in PySide6 installation. Consequently, the plugins "accessiblebridge", and "platforms/darwin" which are not required by Nuitka are removed from the list of plugins to be included. - Adapt tests. Pick-to: 6.8 Task-number: PYSIDE-1612 Change-Id: I89cef4acf102e01c229b1dd6063fc08903ea686d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Fix test example pathFriedemann Kleint2024-11-254-4/+4
| | | | | | | Pick-to: 6.8 Task-number: PYSIDE-1106 Change-Id: I28edb166ca6568841012276679ac290b09e64505 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Delete QQmlApplicationEngine on application exitJaime Resano2024-11-253-6/+9
| | | | | | | | | | | | | | Due to the API limitations, we have to ensure that the engine is deleted before other parts of the application is deleted. Otherwise exposing objects using setInitialProperties() or setContextProperty() for example will cause warnings to be printed. It is a good practice to always delete the engine manually so all the code should be consistent. Task-number: PYSIDE-1612 Pick-to: 6.8 Change-Id: I01f16359e9d90cefd5957708fe12ce489bd7edc0 Reviewed-by: Jaime Resano <Jaime.RESANO-AISA@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* 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 <Friedemann.Kleint@qt.io>
* Documentation: Fix qdoc to runFriedemann Kleint2024-11-211-0/+16
| | | | | | | | | | | Adapt to qtdoc/545681fbf071aa1c2ccc7a1211814440e592314a. Pick-to: 6.8 Task-number: PYSIDE-1106 Change-Id: I5697cdc2ec8798b09a8b13f715821f012aeb3d74 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* 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 <Friedemann.Kleint@qt.io>
* Documentation: Mention that qtpip requires a licenseFriedemann Kleint2024-11-191-0/+3
| | | | | | | Pick-to: 6.8 Task-number: PYSIDE-2926 Change-Id: Iadbbdfea8a5f515ef46f7a32169cd6d19b3ae77d Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Finance Manager - Part 3 - DocumentationShyamnath Premnadh2024-11-142-0/+206
| | | | | | | | | | - Expanding on part2 documentation to include detailed steps on creating a backend REST API using FastAPI and SQLite. Pick-to: 6.8 Task-number: PYSIDE-2850 Change-Id: Icfe2b9582e53b1fc59a67be661da1c5fe290fe6f Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Finance Manager - Part 2 - DocumentationShyamnath Premnadh2024-11-132-2/+119
| | | | | | | | | | - This tutorial expands on part1 by integrating SqlAlchemy with PySide6, by storing the data in a SQLite database. Pick-to: 6.8 Task-number: PYSIDE-2850 Change-Id: I195149bd861b1fb1a25623a9fe05e42f1e85054c Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Finance Mananger - Part 1 - DocumentationShyamnath Premnadh2024-11-138-2/+478
| | | | | | | | | | | | - Detailed tutorial with instructions, explanaton of code concepts, gifs, steps to run and deploy the application. - Additionally, register a new role {deco} to be used in markdown. It is the same as :deco: in reStructuredText. Pick-to: 6.8 Task-number: PYSIDE-2850 Change-Id: Icb732e830948ee7ad1cb9dcf6bd07b5077c89497 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: add titles for extra pagesCristián Maureira-Fredes2024-11-1316-0/+48
| | | | | | | | | | | | The custom pages that document specific classes/functions need a title to be properly displayed once searching in the documentation page. The extra module pages don't need a specific title. Change-Id: Icff3991cc1dee38a2072b49810b22a5bf228147e Pick-to: 6.8 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Update libclang versionEce Cinüçen2024-11-121-1/+1
| | | | | | | | libclang 16 was not working, and to have consistency it is changed to 18+ Pick-to: 6.8 Change-Id: I54e4db59f45ff90bc19916ca77434eb2541272b4 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: reduce size of class headersCristián Maureira-Fredes2024-11-121-0/+12
| | | | | | Change-Id: I7d22571e97e9bbbca663783aaa480b21e1bc991c Pick-to: 6.8 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: Avoid same name for directory and main qml fileCristián Maureira-Fredes2024-11-1115-30/+32
| | | | | | | | | | | | | | | | | | Discovered while testing deployment on macOS, nuitka fails when the directory and file (e.g. Main/Main.qml) have the same name. This might be able to be fixed by other arguments or even upstream in Nuitka, this is a simple change that will encourage people not to use the same name in the meantime Pick-to: 6.8 Fixes: PYSIDE-2919 Task-number: PYSIDE-2910 Change-Id: I596d820e4a30996f9cf934a9f93e6436e51ad0d2 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* 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 <Friedemann.Kleint@qt.io>
* 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 <cristian.maureira-fredes@qt.io>
* Fix extra class documentationFriedemann Kleint2024-10-2419-394/+392
| | | | | | | | | | | - Add indentation - Use refs for classes and decorators - Fix method/parameter listings Pick-to: 6.8 Change-Id: Iaada9d40e734935d5e56d75fc2a9b1a72da58e33 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Improve the Signal and Slots tutorialFriedemann Kleint2024-10-241-21/+31
| | | | | | | | | | Introduce references. Add a note pointing to the Qt.ConnectionType parameter. Pick-to: 6.8 Task-number: PYSIDE-2901 Change-Id: Ibed6d439ef536053dc00c1b941b6d0b02f626b95 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Reformat documentation of class SignalFriedemann Kleint2024-10-241-36/+39
| | | | | | | | | | Turn it into a proper class documentation, which can be referenced. Fix the tutorial link. Pick-to: 6.8 Task-number: PYSIDE-2901 Change-Id: Id09946fc8598ccc0eb9658ae1a8a5cbef102a2e5 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Fix image URLFriedemann Kleint2024-10-241-1/+1
| | | | | | | | | Adapt to qtbase/482287debbecf0c4ee9057faed2c17f0e1126b56. Task-number: QTBUG-69988 Pick-to: 6.8 Change-Id: I9277b74fa9d7cb2029921432cda96bf552d7ccca Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Fix some flake8 warnings in configured Python filesFriedemann Kleint2024-10-211-8/+9
| | | | | | Pick-to: 6.8 Change-Id: Idd43e3263d27217f142b9f484d3053fb0b832677 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Add a note about @property and QMLFriedemann Kleint2024-10-181-0/+4
| | | | | | Pick-to: 6.8 Change-Id: I03fd38ffbae1a9a38b8d7efc130c0460da45534f Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Release Notes: Fix for full documentation buildShyamnath Premnadh2024-10-111-1/+15
| | | | | | | | | | - Fix for full documentation build by adding a new cli option for the output directory. Pick-to: 6.8 Task-number: PYSIDE-2853 Change-Id: I06d76567364a4fbc37cb3f8d03a2020d93b9e513 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Android Deployment: Update the documentationShyamnath Premnadh2024-10-081-9/+95
| | | | | | | | | | | | - Add instructions to download Android SDK and NDK. - Add instructions to download the wheels. - Modified 'How to Use' section to include the new instructions. Pick-to: 6.8 Task-number: PYSIDE-1612 Task-number: PYSIDE-2620 Change-Id: I4d5e4ec634e149288a1f923fe506611dcd09af27 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Fix API pageFriedemann Kleint2024-10-081-1/+1
| | | | | | | | | Amends 008853632d48752ff4604f6ac2f13fe351ff7139, bc87b5d3319d758827edcdff2798777bcf36ae6b. Pick-to: 6.8 Change-Id: Ic1d2cb5dc2b19995cd9dfab2311d761d411837e5 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Update API (front page) module documentationFriedemann Kleint2024-10-012-18/+21
| | | | | | | | | | | | | Fix titles and wording according to qtdoc..qtmodules.qdoc (similar to bc87b5d3319d758827edcdff2798777bcf36ae6b). Add the Quick Controls module to the API page. In the Quick Controls module page, add the list of controls/QML types. Task-number: PYSIDE-1112 Change-Id: Ie68e00e8eac9194142e3d1625c72557455bc68c6 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* shiboken6/Documentation: Extract images from the .rst module descriptionsFriedemann Kleint2024-09-301-1/+1
| | | | | | | | | | | | | | | Images referenced in our .rst module descriptions in the "extras" directory (which are usually extracts of the WebXML module documentation) so far only were shown when they were also referenced from another parsed WebXML document, causing them to be copied to the doc/base directory. Add a function to extract them from the .rst document and pass them to the image resolving functions along with the source file path. Task-number: PYSIDE-1106 Change-Id: I8efbca9f6a63e2aea6dc25596c496cb41517bc32 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* shiboken6/Documentation: Fix a syntax error in the modules listFriedemann Kleint2024-09-301-1/+1
| | | | | | | | | | | Amends bc87b5d3319d758827edcdff2798777bcf36ae6b. Task-number: QTBUG-77650 Task-number: PYSIDE-2620 Task-number: PYSIDE-1106 Pick-to: 6.7 Change-Id: I07604e3fb281fe9441bc69d189600c22f66b44a5 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Fix paths to additional documentsFriedemann Kleint2024-09-271-375/+373
| | | | | | | | | | | | | The additional documents were no longer found after qttools/c51980bb0d9658f2ade4de1900d07b08e88cb52d. Add the directories. Complements 752c1161d75f8c01e2c6c6b07ba02e9a62e65b10. Task-number: QTBUG-77650 Task-number: PYSIDE-2620 Change-Id: I57f0eb212dc8b2eae6786135e0fb85b1ac526022 Reviewed-by: Christian Tismer <tismer@stackless.com>
* 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>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-12 18:30:24 +0000