aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/extras
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: Update QtQml/QtQuick modulesFriedemann Kleint2024-12-132-58/+99
| | | | | | | Task-number: PYSIDE-1106 Pick-to: 6.8 Change-Id: If09bf185c5fa23c2866bab23c7bd9570828000c1 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* shiboken6/Documentation: Prominently display QML typesFriedemann Kleint2024-12-1310-19/+1
| | | | | | | | | | | | | | | | | | | Previously the link to the QML types list (Qt web documentation) was automatically inserted into the last paragraph of the module description. This only had an effect when no PySide module description was present. Otherwise, it had to be manually added to the module description which was overlooked for some modules. To fix this, extend the module documentation obtained from the doc parsers by the URL to page and format it as a separate section preceding the class list. Remove the QML types from the PySide module descriptions. Pick-to: 6.8 Task-number: PYSIDE-1106 Change-Id: I0b107a81b239405c0258ecff924aef87472f13b0 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix trailing empty linesFriedemann Kleint2024-12-131-1/+0
| | | | | | Pick-to: 6.8 Change-Id: I1a5964463f703ade0657816cb974206355a5ae5b Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Update basic module pagesFriedemann Kleint2024-12-112-29/+6
| | | | | | | | | | - QtCore: Add IPC and permissions - QtGui: Remove section on Vulkan as there are no bindings Task-number: PYSIDE-1106 Pick-to: 6.8 Change-Id: Iad520387062b81b8b3be0c2c875fce674788283d Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Add groupsFriedemann Kleint2024-12-106-1/+36
| | | | | | | | | | | | | | There are some special WebXML pages indicated by a <group> element that contain lists of classes with brief suitable for a "class list by function" section. Generate them to a separate directory for clarity and add them to the module pages. Task-number: PYSIDE-1106 Pick-to: 6.8 Change-Id: I4e2d0ef8c626502230078415a24547cd80c95bd9 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Fix tutorial referencesFriedemann Kleint2024-12-103-3/+3
| | | | | | | | Amends d2318d7aab3616df6e589b6337d2c2b8cd6e1909. Pick-to: 6.8 Change-Id: Ibb61ad87b76a7432d2f9917dc36b88d62fe27b59 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@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>
* 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>
* 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>
* 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>
* Update API (front page) module documentationFriedemann Kleint2024-10-011-0/+1
| | | | | | | | | | | | | 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>
* Documentation: Remove example anchorsFriedemann Kleint2024-08-161-2/+2
| | | | | | | The example_gallery tools also adds anchors, use these instead. Change-Id: I488250fae608cf50804c3edfe0ec12d4aa08194a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add QtWebViewShyamnath Premnadh2024-07-311-0/+25
| | | | | | | | | [ChangeLog][PySide6] QtWebView has been added. Pick-to: 6.5 6.7 Task-number: PYSIDE-2825 Change-Id: I4617cb6b170b37c232ba55aa8be374f150604105 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Add QtQml.ListPropertyFriedemann Kleint2024-04-231-0/+24
| | | | | | | Pick-to: 6.7 Task-number: PYSIDE-2698 Change-Id: If9b9af49bb351fcb4e2355277ff84bd0936b5033 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Fix ClassInfo to be a proper decoratorFriedemann Kleint2024-04-221-7/+5
| | | | | | | Pick-to: 6.7 Task-number: PYSIDE-1106 Change-Id: I298769db5455368fca6890571546d4cf74ace957 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation/QmlSingleton: Remove mention of Q_OBJECTFriedemann Kleint2024-04-041-1/+1
| | | | | | | | It does not exist in Python. Pick-to: 6.7 Change-Id: Ib52635df70148f604b066435e50653d1126a80dc Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Rename Qt Designer to Qt Widgets DesignerFriedemann Kleint2024-03-257-9/+11
| | | | | | | | | | | | | Use *Qt Widgets Designer* (emphasis/italics) instead of **Qt Widgets Designer** (bold) consistently. Also fix pyside-designer.rst (Qt Widget Designer -> Qt Widgets Designer). Pick-to: 6.7 Task-number: QTBUG-122253 Change-Id: I573264f5b02c62e4b91cfc0f8b0f38da691defed Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@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>
* 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-018-97/+57
| | | | | | | | | | | | | | | 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>
* doc: fix some issues found with rstcheckCristián Maureira-Fredes2024-01-0815-98/+120
| | | | | | | | | | 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>
* Add QtQuickTestFriedemann Kleint2023-12-241-0/+58
| | | | | | | | | | [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: remove double white spaceCristián Maureira-Fredes2023-11-211-1/+1
| | | | | | 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>
* 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>
* Documentation: Remove mentions of decorator form of signalsFriedemann Kleint2023-04-241-4/+3
| | | | | | | | | | 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>
* Documentation: Add note stating that QApplication is required for the Qt ↵Friedemann Kleint2023-01-091-0/+4
| | | | | | | | | Charts QML types Pick-to: 6.4 6.2 Task-number: PYSIDE-2179 Change-Id: Ic7ab5681fce56202eda89e6aa22ad589549f70bf Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add QtSerialBusFriedemann Kleint2022-10-141-0/+46
| | | | | | | [ChangeLog][PySide6] QtSerialBus has been added. Change-Id: I661912279fa03b51d19483b603fff830ede225a9 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PyEnum: write about new Enums and Forgiveness ModeChristian Tismer2022-09-201-3/+2
| | | | | | | | | | | | | | | | The new Python enums are described in detail and the similarities and problematic differences explained. Then the forgiveness mode is introduced, showing that most incompatibilities can be ignored, although this mode is not encouraged for new code. Task-number: PYSIDE-1735 Change-Id: Ib0d28745ce430a97a84e52522a5aa0cbbe3f3581 Pick-to: 6.3 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: change http by httpsCristián Maureira-Fredes2022-04-018-8/+8
| | | | | | 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-232-0/+3
| | | | | | | Pick-to: 6.2 Fixes: PYSIDE-1863 Change-Id: I7bf2c04ad5a5ab7b5bb29b082ee9d3fbf3b51c2a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PySide6/Documentation: Add module descriptionsFriedemann Kleint2022-03-1629-11/+1346
| | | | | | | | | 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-161-0/+31
| | | | | | | | Amends 65b6c342f0f9c2cf6006f7ebd78dd06e66e1ef1a. Task-number: PYSIDE-1570 Change-Id: I869a706bab514b87c870e8faa994cc1acf36be2e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add constructor documentation to Signal/SlotFriedemann Kleint2022-03-142-4/+37
| | | | | | | | 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>
* 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>
* 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>
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-28 04:39:28 +0000