aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* doc: add page for pyside6-rccCristián Maureira-Fredes2024-03-191-0/+55
| | | | | | | Adding a small description and a reference to our tutorial. Change-Id: Ia3829d04cb824050023798078a1e23e7d0a5f471 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* doc: Link translation tools to the "Translating Applications" tutorialFriedemann Kleint2024-03-191-4/+4
| | | | | Change-Id: I0915e2bc74f0b77491345c4f37d5f8220d8848ce Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: add page for pyside6-qmlcachegenFriedemann Kleint2024-03-191-0/+25
| | | | | Change-Id: Ieac855ed8bf776759ee314ea99d25613eef03d2c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: add page for pyside6-qmlimportscannerFriedemann Kleint2024-03-191-0/+53
| | | | | Change-Id: If416d5067fb5dcf02bd8802e3cb6795c6f0e75f5 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: add page for pyside6-qmltyperegistrarFriedemann Kleint2024-03-192-2/+19
| | | | | Change-Id: I681454e28eb0eec8a920a415719c195549f403fc Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: add page for pyside6-qmllintFriedemann Kleint2024-03-181-0/+49
| | | | | Change-Id: I58b885287ab531f8b88267278688251a3fcf9941 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: update pyside6-deployShyamnath Premnadh2024-03-181-5/+37
| | | | | | Task-number: PYSIDE-1612 Change-Id: Ifcc019542754785e8429231f302411aea37f0ee7 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: add page for pyside6-metaobjectdumpFriedemann Kleint2024-03-181-0/+92
| | | | | Change-Id: I3a45fe6cd80deb522f0b5da95027e74c582291f7 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: add page for pyside6-assistantFriedemann Kleint2024-03-182-0/+21
| | | | | Change-Id: Ic3b462e097f1633e97c5b7bcecc0f5454b5f504c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: Add pyside6-qmlShyamnath Premnadh2024-03-141-0/+8
| | | | | | | Pick-to: 6.6 Task-number: PYSIDE-2640 Change-Id: I03e42470055448d84899f7a167bd1a3dd3f41efc Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Deprecation Python 3.8Cristián Maureira-Fredes2024-03-122-4/+1
| | | | | | | | | | | The changes related PYSIDE-939 can be removed when 3.9 support is dropped, because the problem was fixed and included in 3.9.13 so we cannot assume everyone will be on that version or superior. Change-Id: I78afc660edc6fbb3bb1a2438e17366e63b24e375 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* QtAsyncio: Add handle_sigint argument to run()Adrian Herrmann2024-03-071-0/+5
| | | | | | | | | | | | An argument handle_sigint determines whether QtAsyncio should handle SIGINT (Ctrl+C) and shut down the event loop when it is received. The default is False. This can be set to True if you want QtAsyncio to take care of handling SIGINT instead of your program. Pick-to: 6.6 Task-number: PYSIDE-769 Change-Id: Ie4364025448405f36158a8e997d90ae143961ba8 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Desktop Deployment: Optimize the plugins includedShyamnath Premnadh2024-03-072-0/+33
| | | | | | | | | | | | | | | | - Applications that use certain modules like Multimedia does not work because the plugins for it were not included. However, including all the plugins can make the application executable huge. This patch filters out the necessary plugins by looking at PySide6_Essentials.json and PySide6_Addons.json shipped with the wheels and only bundles these necessary plugins with the application. - Adjust tests. Task-number: PYSIDE-1612 Task-number: PYSIDE-2597 Change-Id: I35c74907a1782ae5101fb7c0861adcb97db5792d Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc/qdoc_spawner: Restore behavior of bailing out when the core index file ↵Friedemann Kleint2024-03-051-0/+6
| | | | | | | | | | | exists Amends cb4d09368dd3719e3e17afa07020c4d41fb03100. Pick-to: 6.6 Task-number: PYSIDE-1106 Change-Id: I90484f3de725a46eaf381a0faaf178d393403162 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Change Enum page to be a proper decoratorFriedemann Kleint2024-03-012-74/+84
| | | | | | | | | Split out QFlag to a separate page for proper indexing. Task-number: PYSIDE-1106 Task-number: PYSIDE-2215 Change-Id: Ibf4e1ad045c272adfa7c0a47bb2fe7ff1781d100 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* PySide6 Permission API: Add considerationsShyamnath Premnadh2024-03-011-0/+56
| | | | | | | | | | - update considerations.rst with a brief about permission API and the shortcoming of the permission API in macOS. Pick-to: 6.6 Fixes: PYSIDE-2468 Change-Id: I95b841716e99d662a72985021aff205da988d221 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Change slot page to be a proper decoratorFriedemann Kleint2024-03-011-42/+27
| | | | | | | Task-number: PYSIDE-1106 Task-number: PYSIDE-2215 Change-Id: I159b4d40240cdc36a02c5f4db347cd5161a8bb23 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add support for decoratorsFriedemann Kleint2024-03-019-98/+59
| | | | | | | | | | | | | | | Add the necessary sphinx modules and configuration. In the doc generator, split out a helper to read an extra documentation page and scan for sphinx directives. Add a decorator list and write it below classes. As a drive-by, outdent the QML decorator descriptions. Task-number: PYSIDE-1106 Task-number: PYSIDE-2215 Change-Id: I813255385af60ab313b10be26fa20c56c768b405 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: List loadUiType() as a function instead a classFriedemann Kleint2024-03-011-35/+0
| | | | | | | | Move the loadUiType() documentation into a doc snippet. Task-number: PYSIDE-1106 Change-Id: I3f878e054f2e6c3a0570f06a340d87661f27cd11 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: Fix broken links to classes provided as extra documentsFriedemann Kleint2024-03-018-32/+8
| | | | | | | | | | | | | | The extra documents were previously plain text documents which can no longer be linked with class type links introduced by 81ae1853d8510909413a46ab0c27c5eb68a7816e. Change them to use a class directive to mark them as classes. Decorators will be treated separately by a follow-up patch. Task-number: PYSIDE-1106 Task-number: PYSIDE-2215 Change-Id: I0a8601bb5e9a0211c8bd79b6204e93d79bdc7219 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Add documentation on pyside6-projectFriedemann Kleint2024-03-014-1/+73
| | | | | | | Task-number: PYSIDE-1112 Pick-to: 6.6 Change-Id: I9b6b01c9dd45440ce0b2832178b11072d33ba06d Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: list tools with a 2 column gridCristián Maureira-Fredes2024-02-292-28/+124
| | | | | | | | | | | | | | Using a similar grid-approach like the main page (without icons) to present the tools per-category. For the tools that have no page, the link is not generated, so there are no broken hyperlinks. Change-Id: I1a4f43b6e86a56988b5bc53f0592c36e69e55777 Pick-to: 6.6 Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Docunentation: Add steps to bump the versionFriedemann Kleint2024-02-291-0/+11
| | | | | | Pick-to: 6.6 Change-Id: I870af04f6d5d515db8f0ff96a4ad6428b3fa6613 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: Fix broken inheritance diagramsFriedemann Kleint2024-02-231-22/+1
| | | | | | | | | After the fixes for PYSIDE-2215 (Intersphinx), the functions fixing the URLs do more harm than good. Remove them. Task-number: PYSIDE-2215 Change-Id: I3324edd149cb7c5f3645c30069c46d5dc5f9d223 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Fix flake8 warnings in documentation scriptsFriedemann Kleint2024-02-234-17/+10
| | | | | | Pick-to: 6.6 Change-Id: I5323989df5e489f28eb69593597329ff86b2b614 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Link more tools from the package details pageFriedemann Kleint2024-02-161-2/+2
| | | | | | | | Pick-to: 6.6 Task-number: PYSIDE-1112 Change-Id: Idec746d10be03174c6ec74e9ad18cb1287385925 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Fix broken link to widget styling tutorialFriedemann Kleint2024-02-131-2/+2
| | | | | | | Pick-to: 6.6 6.5 Fixes: PYSIDE-2603 Change-Id: Ic0be86e7672b0b88f5512424bed98a36cd68a305 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* pyside6-project: Add a command for running lupdateFriedemann Kleint2024-02-121-0/+8
| | | | | | | | | [ChangeLog][PySide6] pyside6-project now has an lupdate mode updating translation files (.ts) from the sources. Change-Id: I853e55455fff2c0c22a7099c650e4bd3b2fc52c4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Qt Linguist example: Enable building translations with pyside6-projectFriedemann Kleint2024-02-121-4/+10
| | | | | | | | | Remove the use of the "translations" directory and make it a resource prefix instead. Adapt the tutorial accordingly. Pick-to: 6.6 6.5 Change-Id: I9b7da17b4aac6a1470f5105b33a6267c78e1c26b Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Link the Qt Linguist and GNU gettext examplesFriedemann Kleint2024-02-011-2/+2
| | | | | | | Pick-to: 6.6 Task-number: PYSIDE-1112 Change-Id: Ica9c369f488afae6206b30e17d3743e0f3772642 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* QtAsyncio: Introduce quit_qapp argumentAdrian Herrmann2024-01-301-0/+13
| | | | | | | | | | | | | | | | A new optional argument quit_qapp can be passed to QtAsyncio.run() to configure whether the QCoreApplication at the core of QtAsyncio should be shut down when asyncio finishes. A special case where one would want to disable this is test suites that want to reuse a single QCoreApplication instance across all unit tests, which would fail if this instance is shut down every time. Pick-to: 6.6 Fixes: PYSIDE-2575 Task-number: PYSIDE-769 Change-Id: I49cd0a50311fb30cc50df9b7f6a6d73fe8c58613 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Make Unity builds defaultFriedemann Kleint2024-01-301-2/+2
| | | | | | | | | | [ChangeLog][PySide6] setup.py now uses CMake Unity Build Mode by default. Change-Id: I50c892646c73ac636276460b0a1efa558531c76d Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* 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 <tismer@stackless.com>
* doc: Update copyright year to 2024Adrian Herrmann2024-01-261-1/+1
| | | | | | | | | The copyright year on the documentation footer hasn't been updated since 2021. Pick-to: 6.6 Task-number: PYSIDE-1112 Change-Id: I8a8c1c07e77a9396479d08913f8e4b9133751bd6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* 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 <cristian.maureira-fredes@qt.io>
* Docs: adapt extendedexplorer tutorial to v2Dennis Oberst2024-01-2319-455/+824
| | | | | | Change-Id: If52e8d2cc1f59c1793bc9edee798a2ec5c5a8fad Fixes: PYSIDE-2576 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: Fix error handling in qdoc_spawnerFriedemann Kleint2024-01-191-15/+16
| | | | | | | | | | | | | Check on the exit code, not on the presence of warnings on stderr to determine failures. Amends 9bbbb29809ec7552698680a40e20ec271d929c67, cb4d09368dd3719e3e17afa07020c4d41fb03100 Pick-to: 6.6 Task-number: PYSIDE-1106 Change-Id: I092b5f991c1bb114a1d51f73bd833da5aedaeda8 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: propagate error from qdoc_spawnerCristián Maureira-Fredes2024-01-182-15/+22
| | | | | | | | | Amends f2db4487f5902d47496bc9c00896f81566d3b59a. Task-number: PYSIDE-1106 Change-Id: Ibcc229d28e797235b7d62a471d1ff51917c59d80 Pick-to: 6.6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: use modified version of the sphinx themeCristián Maureira-Fredes2024-01-181-0/+5
| | | | | | | | | | This modifies our requirements in order to use a forked version, including the option 'collapse_navbar' for the theme in order to avoid long build times. Change-Id: Id0f144d19927f481f254397babb95693c131bdc3 Pick-to: 6.6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: spawn many qdoc processes to build the docsCristián Maureira-Fredes2024-01-182-6/+102
| | | | | | | | | | | | | | | | | This introduces a new python script that will spawn many qdoc processes to improve the performance of the current sequential, single-process, qdoc call. To avoid problems with the references, two calls are required, one with '-prepare -no-link-errors' and one with '-single-exec'. Pick-to: 6.6 Task-number: PYSIDE-1106 Change-Id: Ia6e7e937b9db886c1150bd1e804cc9f06563687d Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Style the apiref titlesVenugopal Shivashankar2024-01-171-0/+12
| | | | | | | | | | | With the use 'py:class' sphinx directive for the API reference page, the page title is styled differently. This makes the title smaller than the section that follows after the title. This change bumps the font-size of the title and the theme selector icon. Change-Id: I35f387044564776b74f500cc8e8c04801ea82abf Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Examples: Add Android tagShyamnath Premnadh2024-01-121-1/+8
| | | | | | | | | | | | | | | - Examples that work on Android are tagged Android. - Clicking the tag lists all PySide6 examples supported in Android. - sphinx-tags package added to add blog like tags to examples. [ChangeLog][PySide6] Examples supported on Android are tagged `Android` in documentation Pick-to: 6.6 Task-number: PYSIDE-1612 Change-Id: Ic4ea2c63756d060aeea85b0088da9ae248eda24e Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Add a favicon for browser tabsFriedemann Kleint2024-01-082-1/+1
| | | | | | | | Pick-to: 6.6 Fixes: PYSIDE-2574 Change-Id: Ifa583c9a8ce13f1bdafe4621cb8d1cf5f8d35f79 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: fix some issues found with rstcheckCristián Maureira-Fredes2024-01-0831-145/+172
| | | | | | | | | | 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 <Friedemann.Kleint@qt.io>
* QtAsyncio: Add documentation pageAdrian Herrmann2024-01-053-0/+142
| | | | | | | | | | | | | | | | | | Add a documentation page for QtAsyncio. As a pure Python module, the build process is different from the other modules, as we don't want shiboken to run for it - all we need is a simple rst compilation. The "Copying docs..." step of "ninja apidoc" (see sources/pyside6/doc/CMakeLists.txt) copies the entire sources/pyside6/doc directory recursively into the build directory. We can tap into this to make sure the rst will be in the correct location for the sphinx compilation step. Pick-to: 6.6 Task-number: PYSIDE-769 Task-number: PYSIDE-1112 Change-Id: Ia03a2a4505d745ca052f0edb529e85a8bfb9d552 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Improve tutorial on string-based connectionsFriedemann Kleint2024-01-051-3/+20
| | | | | | | | | | | Mention the use cases (most prominently DBus), give some instructions on how to obtain the signature and link it. Pick-to: 6.6 Task-number: PYSIDE-2547 Task-number: PYSIDE-2563 Change-Id: I303ef09b26a5fc2c0ab14828aa4996e2055f8b95 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Run fewer parallel jobs with sphinxVenugopal Shivashankar2023-12-291-1/+4
| | | | | | | | | | | | | | The current sphinx setup uses `-j auto`, which spawns 16 different python process running at the same time, consuming most of the memory. This leads to crashing the publishing setup as the system runs out-of-memory. Limiting the parallel jobs to certain no. like in this change, avoids this situation. Change-Id: I0b00e563114f56e78a026dd1833435c02e9bc325 Pick-to: 6.6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add QtQuickTestFriedemann Kleint2023-12-243-0/+65
| | | | | | | | | | [ChangeLog][PySide6] QtQuickTest has been added. Fixes: PYSIDE-2543 Change-Id: I949a0e50a2e522589863ade1e2b2335be580a0d7 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Document QtQml's global function as functionsFriedemann Kleint2023-12-214-150/+0
| | | | | | | | | | | Replace the extra documents (which get generated into the class list) by function documentation snippets, so that they show up correctly under "Global functions". Task-number: PYSIDE-1106 Change-Id: I6a5c457669f7f1db1f572f131721dc443a7d5c70 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: clarify the commercial and lts releasesCristián Maureira-Fredes2023-12-203-5/+10
| | | | | | | Fixes: PYSIDE-2558 Pick-to: 6.2 6.5 6.6 Change-Id: Ia606fe3b5734927c296ca89df674ef9cd1615b22 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-15 16:22:20 +0000