aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* doc: order the sidebar contentCristián Maureira-Fredes2022-11-0327-114/+123
| | | | | | | | | | | | | | As a quick-access to all the documentation, the sidebar of the documentation was a mix of topics without any logical order. Creating directories with an index.rst file, and putting the content on the right topic toctree allow us to have a more clear and simple general toc. Change-Id: I43af890ce988946ababcd575d431fc66704c3e85 Pick-to: 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: Add section Developer NotesCristián Maureira-Fredes2022-11-019-61/+206
| | | | | | | | | | | | | Including an item on the main documentation page to list and include all the content already included in the 'developer' documentation directory. Some files were split to improve the readability and structure of the notes. Pick-to: 6.4 Change-Id: Iaf54858cfc902e290af7311106f82042351b9a17 Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: fix gettingstarted and update directoriesCristián Maureira-Fredes2022-11-011-8/+16
| | | | | | | | | | There were a couple of issue with the current version like a broken link, and references to the old build structure. Pick-to: 6.4 6.2 Change-Id: I9687a04f648cb79953934498441fb0f9da70383a Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Build system: Bump versionsFriedemann Kleint2022-10-251-2/+2
| | | | | | | | | | | | State CMake 3.18+ and Python >= 3.7 Task-number: PYSIDE-2091 Pick-to: 6.4 Change-Id: Iad906a48bf4378ceeeebe5a55aeaa3f27ea0a61f Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add a Developer HOWTOFriedemann Kleint2022-10-211-0/+87
| | | | | | | Pick-to: 6.4 Change-Id: Ie6e6f3a5446a080a2a33ba75f710f3fdd88a36cb Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* PySide-doc: Create some developer doc about enum featuresChristian Tismer2022-10-181-0/+159
| | | | | | | | | | | This is the internal documentation of the flags that can control the enum behavior at startup of a script. Task-number: PYSIDE-1735 Change-Id: Ibe9653de04edf2b73ac199e2dad6f7ddf55716da Pick-to: 6.3 6.4 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Add QtSerialBusFriedemann Kleint2022-10-143-0/+56
| | | | | | | [ChangeLog][PySide6] QtSerialBus has been added. Change-Id: I661912279fa03b51d19483b603fff830ede225a9 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PySide-doc: Move the pep384impl_doc.rst into the PySide treeChristian Tismer2022-10-131-0/+704
| | | | | | | | | | | | | | | This document is there since a long time, but was never in the normal document tree. The moved document will reside under a "Notes for Developers" section. Please feel free to comment this old stuff, maybe something is no more true or superseded, and you will surely find some style flowers. Task-number: PYSIDE-560 Change-Id: I73c95721932d492159b81e4a2c013294de9f8c06 Pick-to: 6.3 6.4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PySide-doc: Move the signature_doc.rst into the PySide treeChristian Tismer2022-10-131-0/+376
| | | | | | | | | | | | | | | This document is there since a long time, but was never in the normal document tree. The moved document will reside under a "Notes for Developers" section. Please feel free to comment this old stuff, maybe something is no more true or superseded, and you will surely find some style flowers. Task-number: PYSIDE-510 Change-Id: I4575ada5b3ef325f706bcba54a5bf608dade1f7b Pick-to: 6.3 6.4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix a link to feature-why.rstChristian Tismer2022-10-131-1/+1
| | | | | | | Change-Id: If2f73e1da0722724c83e2fac28ef87d582e3b446 Pick-to: 6.3 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: Fix modules being omitted from the documentationFriedemann Kleint2022-10-121-42/+12
| | | | | | | | | | | | | | | | | | | 327350779203bdde7728a87e513e7e27dfc8e876 introduced a script tools/doc_modules.py that outputs all modules in the correct dependency order to prevent dependent typesystems to be loaded with generate="no". The generated order unfortunately clashed with the special casing in sources/pyside6/doc/CMakeLists.txt for modules with qdocconf files containing several modules. To fix this, move writing of required files (global header, global type system and global qdocfong) to the script tools/doc_modules.py. Only the configure steps for the qdocconf files are done in CMake. Pick-to: 6.4 6.4.0 Task-number: PYSIDE-1106 Change-Id: Ibd6d03e6622a220236298ccd59f03c6612cc908c Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Desktop DeploymentShyamnath Premnadh2022-10-101-0/+7
| | | | | | | | | | | | | | | - One step solution to deploy PySide6 applications using nuitka without worrying about the plethora of cli options provided by nuitka, at the same time retaining the option to specify advanced nuitka options. - Target: Windows, Linux, Mac - All options are specified through a config file. This makes it easier for expansion to android deployment - Tested for projects with QML files, ui files and rc files Task-number: PYSIDE-1612 Change-Id: Iefbdb55fa1c999295fac2a86b1f6d9b9ec45a0b1 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add the dropsite exampleFriedemann Kleint2022-09-261-1/+0
| | | | | | | | | It is useful for testing Drag and Drop operations. Pick-to: 6.3 6.2 Task-number: PYSIDE-841 Change-Id: I5cd6fa20542676317223d6acfdc938d286b4347f Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation/patch_qhp.py: Strip the module from the indexFriedemann Kleint2022-09-211-1/+1
| | | | | | | | | | | | | This makes the index actually useable since it is then possible to find a class by starting to type the name. The downside is that there is a conflict with the Qt names if the C++ documentation is installed, too. Pick-to: 6.3 Change-Id: I231a90025b2777fe8ff23fcc9dd669722dcd922e Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add option --no-qt-tools to cross buildingFriedemann Kleint2022-09-201-0/+4
| | | | | | | | | Task-number: PYSIDE-1810 Task-number: PYSIDE-802 Task-number: PYSIDE-2060 Change-Id: Ibc21268687c78d72a052d6556fd8a570ab0dca72 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PyEnum: write about new Enums and Forgiveness ModeChristian Tismer2022-09-202-3/+165
| | | | | | | | | | | | | | | | 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>
* Add the character map exampleFriedemann Kleint2022-09-171-1/+0
| | | | | | Task-number: PYSIDE-841 Change-Id: I1aa30657b904d3814c21f16c2404e057e754a960 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add the QtGui analogclock exampleFriedemann Kleint2022-09-161-1/+0
| | | | | | | | | Uses the ready-made QRasterWindow instead of the QWindow with backing store of the C++ version for simplicity. Task-number: PYSIDE-841 Change-Id: Ib0146b1563405b97f694cc53b382c1188061d6af Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Remove the ported Python examples pages from additionaldocs.lstFriedemann Kleint2022-09-151-110/+0
| | | | | | | Task-number: PYSIDE-2056 Pick-to: 6.3 6.2 Change-Id: I934cb1d593de1d9d56e94f7335bc6c5b3da696a3 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Generate documentation for all modules independentlyFriedemann Kleint2022-09-151-3/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | Previously, only the modules that were built in PySide were considered for documentation, which required one to create a full build just to build the documentation. One reason for this was that the inheritance diagram creation determined the base classes by loading the classes/modules and do introspection. This has been replaced by a mechanism were shiboken creates a JSON inheritance file. It is then sufficient to have the modules built in Qt so that the includes exist for shiboken and qdoc finds the source. Add a script that retrieves the Qt modules built by looking at the Qt include path, rearranges them by dependency order and use that as an input to the documentation checks. With that, a minimal build of PySide6 suffices to generate the complete documentation. The script can be used standalone with an option to print warnings about modules not built in Qt. Task-number: PYSIDE-1106 Change-Id: Iade4c6f1d3d255f7052be94d0a6fd647f5ee4ed3 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add a way to determine base classes from a JSON fileFriedemann Kleint2022-09-152-3/+84
| | | | | | | | | Add another module to inheritance_diagram.py reading the JSON file generated by shiboken6. Task-number: PYSIDE-1106 Change-Id: I19c0797a385f13e34564997b867ab8c70ca05286 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Split out inheritance by import from the Sphinx extensionFriedemann Kleint2022-09-152-117/+157
| | | | | | | | | Make it possible to plug in other ways to get the base classes, avoiding the need to import modules. Add a main for testing. Task-number: PYSIDE-1106 Change-Id: I07c6d4d55b701a030ad199404c59158049fb5e2a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add a way to output inheritance graphsFriedemann Kleint2022-09-141-1/+6
| | | | | | | | This is intended to be used by sphinx for inheritance diagrams. Task-number: PYSIDE-1106 Change-Id: I2195ccb04728e98eb5977ef086c8637e577695a5 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation/patch_qhp.py: Brush up scriptFriedemann Kleint2022-09-131-1/+1
| | | | | | | | | | | - Fix flake8 warnings - Warn about errors - Move line processing into a function for further extension - Make file a positional argument Pick-to: 6.3 Change-Id: Ice191b8b78ff3a151581066ae0fc493ecb54fb64 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Update versions for 6.4Friedemann Kleint2022-09-135-10/+10
| | | | | | | | Drop Python 3.6. Change-Id: I400abc139696c55238f8e1fa95ca4627eb7544b9 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add a special case for PdfWidgetsFriedemann Kleint2022-09-131-0/+2
| | | | | | | | | | Needed since they are contained in the QtPdf qdocconf file. Complements 48258c5a099be2c4accf373a2e2f52d48359cfa2. Change-Id: I2f590e364837ef3cc164474731ac91b8d9839691 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Update documentationFriedemann Kleint2022-09-126-38/+26
| | | | | | | | | | - Use version 6.2 - Delete obsolete paragraphs - Fix some errors Pick-to: 6.3 6.2 Change-Id: I0c86f013fb3ad21a4cc7c5d490a9f129e80f3540 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Sort the modules page alphabeticallyFriedemann Kleint2022-09-121-64/+40
| | | | | | | | | | | Remove some duplication introduced by b81f75fa027076a65747109f2d8ddd9bd904d7dda. Pick-to: 6.3 Change-Id: Iadc1c25ed63120ef360581c5565e72e20b3a996f Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Add QtPdf/QtPdfWidgetsFriedemann Kleint2022-09-072-0/+17
| | | | | | Change-Id: I00073b583c8c84e764a8693b50af44b3b91d55eb Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Documentation: Add QtSpatialAudioFriedemann Kleint2022-09-072-0/+10
| | | | | Change-Id: I6b5474caaf93842ad856d5cbac81aa7603d7d869 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Update the modules pageFriedemann Kleint2022-09-071-2/+60
| | | | | | | | Remove the obsolete QOpenGLFunctions and add some missing modules. Pick-to: 6.3 6.2 Change-Id: I824ee3c125c4fd42d07b55afe7c532c3188bec4c Reviewed-by: Christian Tismer <tismer@stackless.com>
* Fix doc warningFriedemann Kleint2022-09-051-1/+3
| | | | | | | | | | | | | Fix warning: package_details.rst:9: warning: Literal block ends without a blank line; unexpected unindent. Amends 52d38437445f6aa979875a93702496f800b98d63. Pick-to: 6.3 Task-number: PYSIDE-1112 Change-Id: Ifebd2c33625c0612827b9626a312450714584233 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Qt for Python Videos page updateJaishree Vyas2022-09-051-36/+60
| | | | | | | | | | | Videos page needed some editing to look better. Worked after editing some height and width changes. Plus two more videos to the page. Pick-to: 5.15 6.2 6.3 Fixes: PYSIDE-2007 Change-Id: Icdef270d31e80515551c81f8bbe5ebe7ab4e8f7f Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: add section for cmake-only buildCristián Maureira-Fredes2022-09-011-8/+38
| | | | | | | | | | | Adding notes for the recommendation related to building and packaging pyside and shiboken for different scenarios, besides Python wheels, using a CMake. Pick-to: 5.15 6.2 6.3 Fixes: PYSIDE-2005 Change-Id: I02a45c92dc339a32fddb4b2a0de87a5c61483931 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: use more processes for sphinx-buildCristián Maureira-Fredes2022-09-011-1/+1
| | | | | | | | | | Adding the option '-j auto' to the calls we have for sphinx-build, speeding up the documentation generation process. Change-Id: Ie676d305e283fa217a90f3de64f96978ce6b3af0 Pick-to: 5.15 6.2 6.3 Task-number: PYSIDE-1106 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Improve module pages titleFriedemann Kleint2022-08-261-2/+2
| | | | | | | | | Task-number: PYSIDE-2038 Pick-to: 6.3 6.2 5.15 Change-Id: Ib87c2a1ff77bbb0bf71f4f2ca976929780e5b398 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix the modelview programming tutorialFriedemann Kleint2022-08-125-0/+347
| | | | | | | | | | | | | Add some documentation examples and snippets to fix most outstanding C++ to Python conversion errors. The rest looks roughly ok and could be improved by further fixing up the snippet conversion. Task-number: PYSIDE-1984 Pick-to: 6.3 6.2 Change-Id: I8c1bdcbc4a07847b2731ef7e2b9ba666cc00ccd6 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Fix some snippets of the model view tutorialsFriedemann Kleint2022-08-102-0/+42
| | | | | | | | | | Replace the snippets showing the C++ header without implementation; they cannot be extracted from Python examples. Pick-to: 6.3 Task-number: PYSIDE-1984 Change-Id: I373063ea8f3f890bb3b217951cce71feec79951c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Update the VS Code debugging tutorial for WindowsAdrian Herrmann2022-08-092-31/+85
| | | | | | | | | | | Update the "Debugging PySide with VSCode" tutorial so it applies to Windows as well. Task-number: PYSIDE-2000 Pick-to: 6.2 6.3 Change-Id: I487534f3094e2b9a1c2b60733ffe599afe7b39b4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* snippets_translate: Add a way of overriding snippetsFriedemann Kleint2022-08-035-0/+23
| | | | | | | | | | | | Prototypically fix the QInputDialog dialog snippets. Task-number: PYSIDE-1984 Fixes: PYSIDE-1952 Pick-to: 6.3 6.2 Change-Id: Iad75971b8778a6364123963d28f54f02a0c56737 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: add package detail pageCristián Maureira-Fredes2022-07-084-4/+151
| | | | | | | | | | | | To clarify the content of the packages, dependencies, and tools that we include in the wheels. Other files were modified to link the new page. Pick-to: 6.3 Task-number: PYSIDE-1112 Change-Id: I358c47601e2b930b12807dda41382474186baf01 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Fix Documentation - Cross CompilationShyamnath Premnadh2022-07-071-0/+5
| | | | | | | | | | | | | | - Fix symlinks appears as if it were only a part of Option B of prerequisities. This is now fixed by adding a new sub-heading. - Added a note about having same version for host and target Qt. Having 6.3.0 on the host and 6.3.1 on the target, does not work for cross compilation. The documentation mentions same minor version works for cross compilation. However, this works for 6.2.4 on host and 6.2.1 on target. Hence, not completely removing the statement. Pick-to: 6.3 Change-Id: Ic678dbf094998108c55d916074753db41e9a2e0f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix getting started Qt for PythonShyamnath Premnadh2022-07-073-3/+12
| | | | | | | | - the pip install -r requirements.txt command should come after pyside-setup is cloned Pick-to: 6.2 6.3 Change-Id: I4ed8108bf1fb850f773d422472b603ee11d97b87 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix Typo : PySide Debugging TutorialShyamnath Premnadh2022-07-071-1/+1
| | | | | | | | - CMAKE_BUILD_TYPE instead of MCAKE_BUILD_TYPE Pick-to: 6.2 6.3 Change-Id: I542d3828c6b2dad3fa5f48dbedfecf37910fcae8 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Remove left-over archive fileFriedemann Kleint2022-06-301-0/+0
| | | | | | | | Added by 25180730194bec25f915f32ab846ea583fb1493f. Pick-to: 6.3 6.2 Change-Id: Ib6440293f5193972cb5f10c71816b6e7189534a9 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: Fix line numbers in the porting tutorialFriedemann Kleint2022-06-291-3/+3
| | | | | | | | | | Fix warning: sources/pyside6/doc/tutorials/portingguide/chapter1/chapter1.rst.rst:51: WARNING: line number spec is out of range(1-113): '44-122' Amends 99d76b5e4e2397fcb4ddf45de91748ab1861f755. Change-Id: Ic2d30b4b6431bef7406763a27f124fccf30b6f7e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* docs: adapt snippets to new license rowsCristián Maureira-Fredes2022-06-2215-75/+75
| | | | | | | | | | The license headers are now a couple of lines compared to the previous 40 lines, so the snippets that select 'from which line' the code must be included needed some adaptation. Change-Id: Id8bb87d708cc7c9edadb1b8265cecf81bf0bf5ae Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Fix documentation generation for 6.4Friedemann Kleint2022-06-222-3/+3
| | | | | | | | | | Adapt to moved docconf files (qtspeech/07ce95a6094ced5c2a718255d663a6c67d0f26b7, qttools/6af882fa2f45f73ec2ba4066d5ae3ad072d0c5ee). Task-number: QTBUG-95236 Change-Id: I9bf0605822037a88088db81673ad42e5c848acef Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Fix mention of the clang environment variableFriedemann Kleint2022-06-103-8/+8
| | | | | | | | | | Use LLVM_INSTALL_DIR instead of deprecated CLANG_INSTALL_DIR. Pick-to: 6.3 6.2 5.15 Fixes: PYSIDE-1956 Change-Id: I69080670f28267eadd7def6b81599703c9e95fa3 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Use SPDX license identifiersLucie Gérard2022-05-2755-2199/+110
| | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Task-number: QTBUG-67283 Change-Id: I065150015bdb84a3096b5b39c061cf0a20ab637d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>