diff options
| author | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2024-08-05 17:02:16 +0200 |
|---|---|---|
| committer | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2024-08-12 10:21:38 +0200 |
| commit | 44385439c3b9879dfa35a3c5635493beec77cb92 (patch) | |
| tree | b4b55a64c6eb0e972c4075caf7da1680ad2725c7 /sources/pyside6/doc/considerations.rst | |
| parent | 19050e72d1b2be21d95e8d128574a49043a48bd6 (diff) | |
Documentation: Rearrange sections
- 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>
Diffstat (limited to 'sources/pyside6/doc/considerations.rst')
| -rw-r--r-- | sources/pyside6/doc/considerations.rst | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/sources/pyside6/doc/considerations.rst b/sources/pyside6/doc/considerations.rst index dda1d8b0d..c6a07ff56 100644 --- a/sources/pyside6/doc/considerations.rst +++ b/sources/pyside6/doc/considerations.rst @@ -395,8 +395,8 @@ Calendar. More about permission API can be read in this `Blog post`_. When a PySide6 application that uses the permission API is run in interpreted mode, i.e., ``python <main_file>.py``, the code implementing the permission API *will not work*. The only way to make your PySide6 application using permission API work is to bundle the application. For Android, -this means using the `pyside6-android-deploy`_ tool and for macOS, this means using the -`pyside6-deploy`_ tool. +this means using the :ref:`pyside6-android-deploy` tool and for macOS, this means using the +:ref:`pyside6-deploy` tool. When running in interpreted mode, you can skip over the permission check/request using the following *if* condition @@ -413,7 +413,7 @@ check if the application is run as a standalone application or run in interprete Android ~~~~~~~~ -For Android, `pyside6-android-deploy`_ takes care of identifying the necessary permissions needed by +For Android, :ref:`pyside6-android-deploy` takes care of identifying the necessary permissions needed by the application and adding those permissions to the *AndroidManifest.xml* using the *<uses-permission>* element. @@ -433,9 +433,7 @@ contain the *usage description* strings for the permissions required. You can ce *Info.plist* of the Python framework installation to make the Qt permission API work when running a PySide6 application from the terminal. However, this is not recommended. Therefore, the only viable solution is to bundle the PySide6 application as a macOS application bundle using -`pyside6-deploy`_. This macOS application bundle will have its own Info.plist file. +:ref:`pyside6-deploy`. This macOS application bundle will have its own Info.plist file. .. _`Blog post`: https://www.qt.io/blog/permission-apis-in-qt-6.5 .. _`Camera Example`: https://doc.qt.io/qtforpython-6/examples/example_multimedia_camera.html#camera-example -.. _`pyside6-android-deploy`: https://doc.qt.io/qtforpython-6/gettingstarted/package_details.html#deployment -.. _`pyside6-deploy`: https://doc.qt.io/qtforpython-6/gettingstarted/package_details.html#deployment |