aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* 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>
* Documentation: Fix list of additional documentsFriedemann Kleint2023-12-151-180/+27
| | | | | | | | | | | A number of examples have been removed and the Qt Quick Controls 2 module has been renamed. Pick-to: 6.6 Task-number: PYSIDE-1106 Task-number: PYSIDE-2206 Change-Id: I63f392c93d9f09edf60aeb3399d239ec995555c3 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: typo on the signal and slots tutorialCristián Maureira-Fredes2023-12-121-1/+1
| | | | | | Change-Id: Ie0126cf06c2139ad1089a07efed089cf7a615a5d Pick-to: 6.2 6.5 6.6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Shiboken: Remove FindPythonInterp and FindPythonLibs CMake modulesShyamnath Premnadh2023-12-112-4/+3
| | | | | | | | | | | | | | | - They were deprecated since 3.12 and removed in 3.27 - Use FindPython module as replacement - all the Python cmake variables resulted are renamed to their respective variable names as per the FindPython module instead of FindPythonInterp or FindPythonLibs module Pick-to: 6.6 Fixes: PYSIDE-2439 Change-Id: I1d3106e2cc9ee97e2d4f62d4e19e1a591d1021ad Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Print a warning if no URL can be found in inheritance graphsFriedemann Kleint2023-12-061-0/+20
| | | | | | | Pick-to: 6.6 Task-number: PYSIDE-2215 Change-Id: I9d9493411f1df6110de68de29e84209e4cf2a5df Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Add a tutorial for QML DebuggingFriedemann Kleint2023-11-212-0/+33
| | | | | | | | Pick-to: 6.6 6.5 Change-Id: I65ed5d7983099e115429d1af09fd03888eb37f97 Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* doc: remove double white spaceCristián Maureira-Fredes2023-11-2113-23/+23
| | | | | | Pick-to: 6.6 Change-Id: I68b835bb5fa00d35fe5406deee2acc83c7bac7cb Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Add static create() function for decorated QML singletonsFriedemann Kleint2023-11-091-0/+13
| | | | | | | | | | | | | Check for static method named "create()" and use that as a singleton creation callback. [ChangeLog][PySide6] It is now possible to use a static method create(engine) for creating decorated QML singletons. Fixes: PYSIDE-2432 Change-Id: I76c47385a0064733a1949a30d22cc01c280d0423 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: add tooling section to the main gridCristián Maureira-Fredes2023-11-024-24/+73
| | | | | | | | | This add the existing section to our main grid page, so people can found the information quickly. Change-Id: I7f920c91886ebcd591e1aa5dcaf396af941d56c7 Pick-to: 6.6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* docs: deprecate 'build_rst_docs' in favor of 'build_base_docs'Dennis Oberst2023-10-263-29/+35
| | | | | | | | | | | | | | | | | | | The command for building documentation files has been renamed to 'build_base_docs' and the previous command, 'build_rst_docs', has been deprecated. All relevant occurrences of the command have been updated accordingly. In addition, the documentation config and build directory 'build/pyside6/doc/rst' has been renamed to 'build/pyside6/doc/base'. To ensure a fresh start when generating new documentation, the auto-generated `examples` and `html` directories are now deleted before generating new documentation. This change has been made because these directories are generated anyway, and starting fresh ensures that there are no conflicts or issues with the new documentation. Task-number: PYSIDE-2504 Change-Id: I395ad7e9482b0b68311820d58da362513ebb44b2 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: add qtpip and Maintenance tool contentCristián Maureira-Fredes2023-10-181-0/+88
| | | | | | | | | Adding information related the inclusion on the Maintenance Tool, and also the qtpip tool Pick-to: 6.6 Change-Id: Ibbce363b28b980ddb406c63d7dbdce8fcffec5f9 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* libpyside: Implement QMetaMethod::tags() for @SlotFriedemann Kleint2023-10-171-1/+5
| | | | | | | | | | | | | Tags can be used like annotations and are for example used in the DBus module. [ChangeLog][PySide6] An optional parameter "tag" has been added to @Slot, allowing to set QMetaMethod.tag(). Pick-to: 6.6 Fixes: PYSIDE-748 Change-Id: I62bef6179917307471cb72491ac3d05970572f3f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Desktop Deployment: Update docsShyamnath Premnadh2023-10-101-1/+5
| | | | | | | Task-number: PYSIDE-1612 Pick-to: 6.6 6.5 Change-Id: I825b3cf13aba173313bcbef74d2007d3ca4c12b0 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation/Signal slot tutorial: Recommend to use @Slot alwaysFriedemann Kleint2023-08-251-0/+13
| | | | | | | | Task-number: PYSIDE-463 Task-number: PYSIDE-2436 Pick-to: 6.5 6.2 Change-Id: Ida83a0b4207ab499cfaaa2090f8aabbc6246bff5 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: Add note to avoid Windows Store PythonCristián Maureira-Fredes2023-08-142-0/+6
| | | | | | | | Change-Id: I2683d0e95bdb6fbf22974b117562bcc6edae8d3d Pick-to: 6.5 Fixes: PYSIDE-2405 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* pyside6-deploy doc: fix broken linkShyamnath Premnadh2023-08-081-1/+1
| | | | | | Pick-to: 6.5 Change-Id: Ie12b1dbbc2dfa07de29e49ab83dc80d2a4961fe1 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix documentation for QPainter.drawText()Friedemann Kleint2023-08-071-0/+13
| | | | | | | | | | | Inject Documentation and fix the snippet to indicate the QRect return. Task-number: PYSIDE-2411 Pick-to: 6.5 Change-Id: Id52f4c0a875301c6eac4a1d33034a04fa652e0d5 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Developer Documentation: Add documentation hintsFriedemann Kleint2023-08-042-7/+33
| | | | | | | | | | 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 <Shyamnath.Premnadh@qt.io>
* example_gallery: Handle Qt example directoriesFriedemann Kleint2023-08-031-1/+1
| | | | | | | | | | | | | | | Add an option to be able to include examples found in the Qt / qtdoc repository. The build_rst_docs target also uses it if --qt-src-dir is given. It is then possible to include pure QML C++ examples from the qtdoc and other repositories. Task-number: PYSIDE-2206 Change-Id: I1b28d5ba5a134101a21fa936f87264a68bada71e Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: mention --debug option for windows debug buildKeith Kyzivat2023-08-021-0/+2
| | | | | | | | | | | | | | The Windows Getting Started doc page mentions how to build a debug version of PySide6, however it omits that you need to pass the `--debug` option to `python setup.py build`. Mention using `--debug` when building debug. Fixes: PYSIDE-2401 Pick-to: 6.5 Change-Id: I9d5eb1a5e44409f7984f14c5cbf9611efafaf768 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* build: remove traces of distutilsCristián Maureira-Fredes2023-07-142-2/+2
| | | | | | | | | | | | | | | Removed mentions, comments, and fallback usages in some sections of the build scripts and documentation. On the CI, we upgrade setuptools in order to avoid having missing functionality, so it shouldn't be an issue. For Shiboken and CMake, there is still a helper that relies on distutils in case people is using python < 3.8.2 Pick-to: 6.5 Change-Id: Ic33abe9fa8bd8564e9d44c8714b7fedd4e50434a Reviewed-by: Simo Fält <simo.falt@qt.io>
* Fix typo in signal/slot tutorialFriedemann Kleint2023-06-301-1/+1
| | | | | | | Pick-to: 6.5 Fixes: PYSIDE-2376 Change-Id: I9b708903dffd52dd09a34086104149d646fdbab8 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Split out a test driver from the Sphinx inheritance graph generationFriedemann Kleint2023-06-164-101/+148
| | | | | | | | | | | | | | Similar to 5b0918c6c6fa575a16b3ec1637281397e951f62b, 3a1e793c0a91deae4e986efb11724040349ce9ca. Add a note to the README.md and fix it to be viewable. Pick-to: 6.5 Task-number: PYSIDE-2362 Task-number: PYSIDE-1106 Change-Id: I1c0bbc745fffc16d6981e806618c1fce04ac8d18 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix some flake8 warnings in the documentation scriptsFriedemann Kleint2023-06-162-4/+12
| | | | | | | Pick-to: 6.5 Change-Id: Ifbf248d0cc0aae511b3f96cc03baf80f582f5d4a Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* PyEnum: Update docs and rename the optionChristian Tismer2023-06-162-11/+15
| | | | | | | | | | | | | 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 <Friedemann.Kleint@qt.io>
* Developer docs: Add note about optimizing imagesFriedemann Kleint2023-06-071-0/+3
| | | | | | | Pick-to: 6.5 Change-Id: Ie3bbcdba4e600e98c2bd5658a25eacabb37c6b52 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* doc: clarify issue with Qt installationsCristián Maureira-Fredes2023-05-241-13/+24
| | | | | | | | | | | | | | This arose from many similar comments from people new to Python, and wondering about the role of having Qt installed in the system. Additionally, some of the Qt-classes references in the file were not linked to the actual documentation page, so the usage of :ref: rather than :code: is encouraged. Pick-to: 6.5 Change-Id: I3d5560a49b7a89507aa8774771f4a6acacb67d6b Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* 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 <Friedemann.Kleint@qt.io>
* 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 <keith.kyzivat@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Remove mentions of decorator form of signalsFriedemann Kleint2023-04-242-8/+5
| | | | | | | | | | Use class variables instead. Fixes: PYSIDE-2308 Pick-to: 6.5 Change-Id: I4edc07ad2445f05b2db70ca7c1f8e2106177e78b Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Tooling: Add qmlcachegenShyamnath Premnadh2023-04-181-0/+2
| | | | | | Pick-to: 6.5 Change-Id: I21ae563efb9488083289c7deb6435ae7e9405049 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* 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 <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Docs: Update version in Getting StartedShyamnath Premnadh2023-04-183-14/+14
| | | | | | | | - Change 6.4 to 6.5 Pick-to: 6.5 Change-Id: I23babc4a6e1b9fd8870ea88cc1cf8423f40e4480 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Link platform dependenciesFriedemann Kleint2023-04-134-1/+10
| | | | | | | Fixes: PYSIDE-2283 Pick-to: 6.5 Change-Id: I01aeb057dba1232ce38ef077d2a2e5e848544e9d Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: add qrc icons tutorial zipCristián Maureira-Fredes2023-04-122-4/+3
| | | | | | | | | | | the :download: sphinx command doesn't work with directories, so a package is needed to allow people to download them. Pick-to: 6.5 Fixes: PYSIDE-2275 Change-Id: I8599445c30d800d3eae62dc86955b5ec4e982960 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Docs: update libclang versionShyamnath Premnadh2023-04-123-5/+5
| | | | | | Pick-to: 6.5 Change-Id: Iafd8a0212c8c7059421999ee317c0055883cccc6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Docs: add pyside6-android-deploy to package_details.rstShyamnath Premnadh2023-04-121-1/+4
| | | | | | | Pick-to: 6.5 Task-number: PYSIDE-1612 Change-Id: I279b1e57ce4540a6fbdd4507f2ffcce53ccea267 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-17 19:39:23 +0000