aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* Documentation: Remove the C++ QML reference example overwiewsFriedemann Kleint2022-05-051-11/+0
| | | | | | Pick-to: 6.3 6.2 Change-Id: Ia6b76dfde9a3640c1d34fe84be17be92af9001e7 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Drop the HTML in the copyright textVenugopal Shivashankar2022-04-121-1/+1
| | | | | | Pick-to: 6.3 Change-Id: Id0be106e50bb0f33ac38a07db71ee7cfc4946efe Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: change color inactive example tabCristián Maureira-Fredes2022-04-111-0/+5
| | | | | Change-Id: I28fcfa2c832e8ff811a28a1654a91d5d4e636c7f Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: skip the documentation build by defaultCristián Maureira-Fredes2022-04-092-5/+12
| | | | | | | | | | | | | This reverse the current approach of building the documentation by default, and replace the skip-docs parameter by a build-docs one. A warning is printed when the --skip-docs is used, and another warning is displayed when using --doc-build-online without the --build-docs option. Change-Id: I2bf8302881b51e9831795a7e881b106022cdffa8 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Enable sphinx_copybutton extension for PySide tooVenugopal Shivashankar2022-04-081-3/+1
| | | | | | | | In addition, do not disable the copy_empty_lines config in the Shiboken project. Change-Id: I453c3df05d820052bc187d28a60d4e870b2c62f4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: new theme to follow the new Qt Doc styleCristián Maureira-Fredes2022-04-0815-81/+118
| | | | | | | | | | | | | - Use 'furo' sphinx theme which offers a look-and-feel similar to the new Qt Documentation theme. - Change a few colors and styles to keep some details of the previous look-and-feel. - Add sphinx-copybutton extension to enable the copy-button feature against the snippet blocks. - Remove the 'pysidedocs' theme. Change-Id: I2be7186c5b043b4c75c65783abc2eab4056c493e Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* doc: use sphinx panels for the offline docCristián Maureira-Fredes2022-04-081-104/+75
| | | | | | | | | Removing the special case where a HTML table was generated instead of the sphinx-panels. Change-Id: Ic2fe6276cf63ca559c14d9309c2e7cbd3515f2c3 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* CMake: Clean up the config to find doc toolsVenugopal Shivashankar2022-04-051-53/+5
| | | | | | | | | | | Maintain the doctools config in a single place, and include it wherever necessary. Done-with: Alexandru Croitor <alexandru.croitor@qt.io> Pick-to: 6.2 Change-Id: Ib22e8676aa39bbddb616c7018b01b046bb33ae82 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* doc: Add cross compilation guideCristián Maureira-Fredes2022-04-021-0/+252
| | | | | | | | | | | | This guide is based on the commit message from the change that introduced the option to use setup.py to cross compile Shiboken (module) and PySide, plus additional information to configure all the requirements to start the process. Fixes: PYSIDE-1810 Task-number: PYSIDE-802 Change-Id: I03e1b803a809010bc3acd350b518b3c46741619e Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* doc: change http by httpsCristián Maureira-Fredes2022-04-0161-62/+62
| | | | | | Pick-to: 6.2 Change-Id: Id796694e947643152dc0d57dd760efb89ddd8f16 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add QPyQmlParserStatusFriedemann Kleint2022-04-011-0/+10
| | | | | | | | | [ChangeLog][PySide6] class QPyQmlParserStatus for handling QML parser status changes has been added. Fixes: PYSIDE-1876 Change-Id: Ic1066924ec85dc8633f959342921c1d03da1aee4 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Link the Tutorial from the Signal/Slot reference pagesFriedemann Kleint2022-03-233-0/+5
| | | | | | | Pick-to: 6.2 Fixes: PYSIDE-1863 Change-Id: I7bf2c04ad5a5ab7b5bb29b082ee9d3fbf3b51c2a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: Add missing semicolon to CSSFeRD (Frank Dana)2022-03-211-1/+1
| | | | | | | | | | An unterminated CSS directive is causing line height issues in the website documentation for PySide6. Change-Id: Ic1f22d16c3c2d8c9cce884a328153b4843fefdd6 Fixes: QTWEBSITE-1037 Pick-to: 6.2 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Documentation: Update additionaldocs.lstFriedemann Kleint2022-03-162-122/+456
| | | | | | | | | Regenerate the list, removing a number of warnings about non-existent documents. Move information to the README.md. Pick-to: 6.2 Change-Id: I87c131b1a7ff8b5f06ada9eb1739faa45f566095 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PySide6/Documentation: Add module descriptionsFriedemann Kleint2022-03-1630-11/+1358
| | | | | | | | | Add module descriptions and a README.md on how to create them. Pick-to: 6.2 Change-Id: I627205843bedd74e625d14da718e42faac0a2c68 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add QtNfc documentationFriedemann Kleint2022-03-163-0/+40
| | | | | | | | Amends 65b6c342f0f9c2cf6006f7ebd78dd06e66e1ef1a. Task-number: PYSIDE-1570 Change-Id: I869a706bab514b87c870e8faa994cc1acf36be2e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Remove *.qdocconf.in files of removed modulesFriedemann Kleint2022-03-163-6/+0
| | | | | | Pick-to: 6.2 Change-Id: I6d8252bdb7eabee994cbb970df7b778b99dcc30d Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add constructor documentation to Signal/SlotFriedemann Kleint2022-03-143-4/+39
| | | | | | | | As a drive-by, rewrap some paragraphs. Pick-to: 6.2 Change-Id: Ia17c3937bb48a3fab5e573819b5f27b896199240 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Clean up extra documentationFriedemann Kleint2022-03-148-47/+38
| | | | | | | | | Remove obsolete modules. Update and rewrap description texts of existing modules. Add new QtOpenGLWidgets module. Pick-to: 6.2 Change-Id: Ifbe0fec66e964d579348ac0ef438beb8a3ca0a28 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Improve readability of the Property documentationFriedemann Kleint2022-03-021-3/+6
| | | | | | | | | | Put each parameter on one line. Task-number: PYSIDE-1513 Pick-to: 6.2 Change-Id: Ia0ff3c587408f46bfd529278e385320169b108f2 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Implement QQmlPropertyValueSourceFriedemann Kleint2022-02-281-0/+10
| | | | | | | | | | | | | | | As is done with the other interfaces, add a class QPyQmlPropertyValueSource inheriting from QObject and QQmlPropertyValueSource. Store its offset in QQmlPrivate::RegisterType::valueSourceCast if it is found as a base class. [ChangeLog][PySide6] class QPyQmlPropertyValueSource for implementing QML value sources for properties has been added. Task-number: PYSIDE-1709 Change-Id: Icd1bd57972f339f9839ccd8d9bf6ff9e5e16ec62 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Drop Qt Location overviews from the listVenugopal Shivashankar2022-02-281-12/+0
| | | | | | | | | Qt Location is still not ported to Qt 6.x, so we can drop these from the additional docs list. Pick-to: 6.2 Change-Id: I812786f552c1a6a9461d77c9ba450bf8f9f3f9de Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Mark briefcase as supporting Qt 6Friedemann Kleint2022-02-171-1/+1
| | | | | | | Pick-to: 6.2 Fixes: PYSIDE-1817 Change-Id: Ic03aa712e9000a8c02058cc6019a3cc5d861585e Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add the QmlAttached decoratorFriedemann Kleint2022-02-161-0/+40
| | | | | | | | [ChangeLog][PySide6] The QmlAttached decorator has been added. Task-number: PYSIDE-1709 Change-Id: I0301ecc7a9bc7a1b798095e8972b2fe4addf2eaf Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add the QmlExtended decoratorFriedemann Kleint2022-02-161-0/+37
| | | | | | | | | [ChangeLog][PySide6] The QmlExtended decorator has been added. Task-number: PYSIDE-1709 Change-Id: I56d1c75f281f37e9d23c64362ce89c5f1f49723a Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add the @QmlForeign decoratorFriedemann Kleint2022-02-111-0/+33
| | | | | | | | [ChangeLog][PySide6] The @QmlForeign decorator has been added. Task-number: PYSIDE-1709 Change-Id: I7dbba47923efb6a1c3ac4accb2b3adcd3fb6fd9b Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add the @QmlNamedElement decoratorFriedemann Kleint2022-02-091-0/+31
| | | | | | | | | | | Add the decorator and split the registration functions in order to be able to pass a different type name. [ChangeLog][PySide6] The @QmlNamedElement decorator has been added. Task-number: PYSIDE-1709 Change-Id: I081cd33313d7b9c19cb6403ee56ac9d8b1d9e606 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Remove mentions of qmakeFriedemann Kleint2022-02-084-16/+16
| | | | | | | | | It is replaced by qtpaths. Pick-to: 6.2 Task-number: PYSIDE-1814 Change-Id: I0aafa0a8ebfc6fc9fe4eb4887dc740c9ea0e5767 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* CMake: pyside: Add support for cross-buildingAlexandru Croitor2022-02-041-4/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | The pyside project will be cross-compiled either if CMAKE_CROSSCOMPILING is set to TRUE (which is usually set by a CMake toolchain file or computed by CMake itself) or if QFP_SHIBOKEN_HOST_PATH is provided on the command line. Various code is added to ensure the correct target Qt, Python and Shiboken libraries are found, as well as host Qt and shiboken tools. These are specified to the project by setting one of the following vars: - QFP_QT_TARGET_PATH (for device Qt libs and includes) - QFP_PYTHON_TARGET_PATH (for device python libs and includes) - QFP_SHIBOKEN_TARGET_PATH (for device libs) - QFP_SHIBOKEN_HOST_PATH (for host shiboken generator) - QT_HOST_PATH (for host moc and friends) When cross-compiling, pyi file generation is disabled because it's not possible to run a target python interpeter on a host machine. It might be possible to do that by using qemu userland emulation in the future. Task-number: PYSIDE-802 Task-number: PYSIDE-1033 Change-Id: Ifa101e90d83397fa19132f9f0ce21e03b3523a74 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Mention that .ui/.qml files should be passed to lupdateFriedemann Kleint2022-01-131-0/+10
| | | | | | | | Task-number: PYSIDE-1774 Task-number: PYSIDE-1717 Pick-to: 6.2 Change-Id: I7aa2a39e3d768fcbbec953720c8e89824df9f916 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix some doc warnings in the debugging tutorialFriedemann Kleint2022-01-062-4/+4
| | | | | | | | | | | | | | | | | | Fix: - sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst:2: WARNING: Title underline too short. - sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst:21: WARNING: Inline interpreted text or phrase reference start-string without end-string. Change the syntax highlighting to javascript, since json does not like the embedded comments of the MS-extended jsonc, fixing: sources/pyside6/doc/tutorials/debugging/vscode/vscode.rst:21: WARNING: Could not lex literal_block as "json". Highlighting skipped. sources/pyside6/doc/tutorials/debugging/vscode/vscode.rst:47: WARNING: Could not lex literal_block as "json". Highlighting skipped. Amends d727a69e2f58be167845b8179edf1735df6ccf1e. Pick-to: 6.2 Task-number: PYSIDE-841 Change-Id: I171c57e4a7f787559022fbbb14a7eb7bb9f1a91c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add Debugging TutorialShyamnath Premnadh2021-12-2312-0/+309
| | | | | | | | | | | | Add tutorial to debug C++ counterpart of PySide application. This commit provides general instructions to setup everything for debugging and debugging using either QtCreator/VSCode. Pick-to: 6.2 Task-number: PYSIDE-841 Change-Id: I6a95ab64507a304fc19a2cdcdf6d29b6c96cca03 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Update information on building on WindowsFriedemann Kleint2021-12-091-2/+7
| | | | | | | | Point to the Qt downloads for libclang. Pick-to: 6.2 Change-Id: Ic15141e13364abef8cdd06f8ad2eabd07f0b6ac6 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Turn snippets_translate / example_gallery into normal CMake targetsFriedemann Kleint2021-12-091-18/+18
| | | | | | | Pick-to: 6.2 Change-Id: Ib318e8f90dda38566da11877ab52f32eba4762f6 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Generate the examples directly into the build directoryFriedemann Kleint2021-12-081-1/+2
| | | | | | Pick-to: 6.2 Change-Id: If395979b5a1efa869b3c1c7cb12b53bd1e8f1f7c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Re-add the documentation copy stepFriedemann Kleint2021-12-071-0/+8
| | | | | | | | | | | | It is still required to copy the examples, tutorials and extra documentation. Make it dependendant on extras as examples might be generated directly in a later change. This partially reverts 30e4777956513daeba0f55cef50de4881d0bb2f1. Pick-to: 6.2 Task-number: PYSIDE-1721 Change-Id: I81e3935fc8001a7a767a017081f4b1120bd3f8c5 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Remove the snippets copy stepFriedemann Kleint2021-12-071-9/+1
| | | | | | | | | | This is no longer necessary since the snippets have been removed from the repository. Generate them directly into the build directory. Pick-to: 6.2 Task-number: PYSIDE-1721 Change-Id: I0a4d9bc3c466b689fa28a982f608104cc5936570 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Enable URLs in inheritance diagramFriedemann Kleint2021-12-072-4/+28
| | | | | | | | | | | | | Switch graphviz generation to use SVG and add some functions to derive URLs from the attributes. This currently works only within one module; links to classes from other modules lack the required refuri node attribute. Task-number: PYSIDE-1725 Pick-to: 6.2 Change-Id: If93e78a6ba60168992b1acc0b926b5cfb57eeb7d Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Fix snippets resolutionFriedemann Kleint2021-12-071-3/+13
| | | | | | | | | | | | | | | | | Change snippets_translate to replicate the complete Qt tree including module name under the codesnippet directory. Resolving the snippet is then a matter of replacing the Qt source path by the PySide 6 snippet path in the fallback paths contained in WebXML and checking for the converted .py files. This basically reduces the snippet warnings to 0. Pick-to: 6.2 Task-number: PYSIDE-1721 Change-Id: I344004ddd1580f96ebf0c132923388ad08852374 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Drop Qt Location from the doc and CMake configVenugopal Shivashankar2021-12-061-3/+0
| | | | | | | | The Qt Location is not part of Qt 6.x anyways. Pick-to: 6.2 Change-Id: I859c782ca795e90fac937544343fa2d07f7dead4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc build: Fix formatting of include pathsTopi Reinio2021-12-061-3/+3
| | | | | | | | | | | * Add missing separator after the base include path * Remove space between -I and the path. This significantly reduces documentation warnings as reported by QDoc. Pick-to: 6.2 Change-Id: Ic3b3ab0232026c1329cfdb7252fabec927109537 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* inheritance_diagram.py: Complete migration to f-stringsFriedemann Kleint2021-12-031-12/+11
| | | | | | | | | Amends d9f344fcef6bec04a787f9ea9f4ea94f15eaa26c. Task-number: PYSIDE-1725 Pick-to: 6.2 Change-Id: If4758a422d211a90ebf0a300502a730b61030ef7 Reviewed-by: Christian Tismer <tismer@stackless.com>
* snippets_translate: Enable all modulesFriedemann Kleint2021-11-291-3/+1
| | | | | | | | | | | | | Fix a fixme commment. To make this pass, make the conditions matches more strict and add some warnings and error handling. Remove the checking of stderr from the CMake statement as this will produce some warnings. Pick-to: 6.2 Task-number: PYSIDE-1721 Change-Id: I8aeefa8355144d98524a622733d82d337cd3c23b Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* CMake: Cleanup documentation building codeAlexandru Croitor2021-11-261-10/+94
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Move conditions on whether documentation should be built inside the doc project, rather than outside. Look for qdoc and qhelpgenerator both in PATH and via find_package(Qt6Tools) calls. Add sanity checks that the various tools used in the add_custom_command calls are actually available. Show a warning or error when they are not available, depending on combination of whether it's a standalone doc build or part of the overall shiboken/python build. Set DOC_OUTPUT_FORMAT to html by default if it's not specified. Clean up some of the warning messages. Make sure to check the result of running execute_process on the snippets tool. Pick-to: 6.2 Task-number: PYSIDE-1718 Change-Id: I2969d7a40961881ad0f91d7142b29a7f4130f3b7 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Fix most sphinx errors "Inline strong start-string without ↵Friedemann Kleint2021-11-231-1/+1
| | | | | | | | | | | | end-string." Ensure characters following a formatting end are escaped by adding handling and some RST manipulators to class TextStream. Task-number: PYSIDE-1112 Pick-to: 6.2 Change-Id: I167160cd18fd890d73e31738487d2c91e012196c Reviewed-by: Christian Tismer <tismer@stackless.com>
* PySide6: Fix documentation for QmlUncreatableFriedemann Kleint2021-11-161-8/+9
| | | | | | | | | | | Add a blank line for code-block to work and fix the indentation. Amends a421aab61ad03afa595aa0ba7e53d84b1edbe892. Pick-to: 6.2 Task-number: PYSIDE-1709 Change-Id: Idecb8a69b510191ab1ea27754d71eb94b2f6394a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add a QmlSingleton decoratorFriedemann Kleint2021-11-162-0/+27
| | | | | | | | | | Add a simple decorator function that stores the type in a list for the QmlElement decorator to use singleton registration. Task-number: PYSIDE-1709 Pick-to: 6.2 Change-Id: I075d583404bd60dc52b84c23a3d09e50d32a5a3a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add a QmlUncreatable decoratorFriedemann Kleint2021-11-152-0/+32
| | | | | | | | | | | Add a class type that stores the reason and registers the type in the call operator. This is then queried by the register type helper functions. Pick-to: 6.2 Task-number: PYSIDE-1709 Change-Id: I0dd0c4c1e05e6e0ee6f22a6947b85546fc373fb9 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* PySide6: Add a QmlAnonymous decoratorFriedemann Kleint2021-11-101-0/+22
| | | | | | | | | | Split out a helper from the qmlElementMacro() to register (also preparing for uncreatable types) and add the decorator. Pick-to: 6.2 Change-Id: I0f3ebf6f31c141083440abcc9f1acd227ce046d7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: replace api module table with panelsCristián Maureira-Fredes2021-11-103-114/+338
| | | | | | | | | | This fix the warnings introduced by a previous change. Pick-to: 6.2 Change-Id: Ie25db8f8e466103487cda9ca4032bd75fab69e7b Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-18 18:46:03 +0000