aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/considerations.rst
Commit message (Collapse)AuthorAgeFilesLines
* Fix tutorial referencesFriedemann Kleint2024-12-101-3/+3
| | | | | | | | Amends d2318d7aab3616df6e589b6337d2c2b8cd6e1909. Pick-to: 6.8 Change-Id: Ibb61ad87b76a7432d2f9917dc36b88d62fe27b59 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Docs: Fix broken links from base documentationShyamnath Premnadh2024-08-161-1/+1
| | | | | | | | - Many https links and sphinx references which were broken have been fixed. Change-Id: Ia10a44bbbbe4ed7e761c72042b45a46030d02186 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Rearrange sectionsShyamnath Premnadh2024-08-121-6/+4
| | | | | | | | | | | | | | | | | | | | | - Rename 'Quick Start' to 'Getting Started'. Also, update the links accordingly. - The page 'Getting Started' is a building from source page. Hence renamed it accordingly with 3 sections - Linux, macOS and Windows. Each sections contains the steps to build from source for the specific platform. - Move 'Package Details' into the main table of contents - Move 'Porting from PySide2 to PySide6' into the 'Getting Started' section. - Additionally, fix the links accordingly and also fix some broken links - Additionally, increase the minumum Python version from 3.7 to 3.8 in the Getting Started section. Task-number: PYSIDE-2833 Task-number: PYSIDE-2837 Change-Id: I07f35dbe583533ff122f6ecb4deeb9c95389b3d1 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@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>
* PyEnum: Update docs and rename the optionChristian Tismer2023-06-161-8/+10
| | | | | | | | | | | | | 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>
* doc: fix issues with pyside rst filesCristián Maureira-Fredes2023-04-051-11/+7
| | | | | | | | | | Fixing extra indentation, syntax issues, and formatting. Adapting too some snippet line highlights, and many other details. Pick-to: 6.5 Change-Id: Ife4eb5cec03577b2902d409b4007ae6d12141747 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: update versions and broken linksCristián Maureira-Fredes2023-02-161-1/+1
| | | | | | | Pick-to: 6.2 6.4 Change-Id: Ib6223ac742b7c7777d2b6110a395b508e5031a75 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* doc: order the sidebar contentCristián Maureira-Fredes2022-11-031-19/+19
| | | | | | | | | | | | | | 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>
* PyEnum: write about new Enums and Forgiveness ModeChristian Tismer2022-09-201-0/+163
| | | | | | | | | | | | | | | | 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>
* PySide6: Add some information on the toolsFriedemann Kleint2021-06-171-0/+19
| | | | | | Task-number: PYSIDE-1378 Change-Id: I9433fd3b1d4d09c6a7d961d67c103ccd651e5beb Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* feature: write some documentation that explains featureChristian Tismer2021-03-011-1/+57
| | | | | | | | | | | | | | | | Features were a little bit visible in 5.15 already. In 6.0, they were also mentioned in some tutorial, but the main PySide documentation was lacking official information. This text shall provide exact information about features, what they are and why we wanted them. Task-number: PYSIDE-1019 Change-Id: I86ff36b76b9aef602cff485daf583570f9b7292c Fixes: PYSIDE-1481 Task-number: PYSIDE-1483 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: Update references to Qt6Cristian Maureira-Fredes2020-12-091-1/+1
| | | | | | | | | | | * Updating versions, * Removing references to 5.x * Remove unavailable modules for Qt 6.0.0 * Comment unusable tutorials from the documentation Change-Id: I924953f97406ab8c5c04005a2d42dfbc03fdf7fa Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Rename PySide2 to PySide6Friedemann Kleint2020-11-021-0/+149
Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I845f7b006e9ad274fed5444ec4c1f9dbe176ff88 Reviewed-by: Christian Tismer <tismer@stackless.com>