aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/gettingstarted
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: Rearrange sectionsShyamnath Premnadh2024-08-127-1063/+0
| | | | | | | | | | | | | | | | | | | | | - 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>
* Documentation: Update versions for Qt 6.8Friedemann Kleint2024-05-284-22/+34
| | | | | | Task-number: PYSIDE-2620 Change-Id: Iff5ac3c8281893adfa0ba3cbd64936fd7c4d6257 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Fix link to Python downloadsFriedemann Kleint2024-04-021-1/+1
| | | | | | Pick-to: 6.7 6.7.0 6.6 6.5 6.2 Change-Id: Ieee77eb36266b6425cb8569b42263532ecbc27a5 Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
* Documentation: Use single emphasis for Qt toolsFriedemann Kleint2024-03-251-9/+9
| | | | | | | | Do some minor corrections. Pick-to: 6.7 Change-Id: If5b3f451a7d4005521bc78bc9683bf7b449d02fc Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Doc: Rearrange tools pageShyamnath Premnadh2024-03-201-174/+2
| | | | | Change-Id: I5f8212fe20ea2ec099769005b4a4920d70d86425 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* doc: Add page for pyside6-linguistAdrian Herrmann2024-03-201-3/+3
| | | | | | Change-Id: I7151c589a8d619f6ba822e7995eb342600ef8015 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Doc: Add pyside6-qmlShyamnath Premnadh2024-03-191-4/+4
| | | | | Change-Id: I5fa5397cf3f7e9c70e58adec7321f02ba7d38c9d Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* doc: Link translation tools to the "Translating Applications" tutorialFriedemann Kleint2024-03-191-4/+4
| | | | | Change-Id: I0915e2bc74f0b77491345c4f37d5f8220d8848ce Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: add page for pyside6-qmltyperegistrarFriedemann Kleint2024-03-191-2/+2
| | | | | Change-Id: I681454e28eb0eec8a920a415719c195549f403fc Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: Add pyside6-qmlShyamnath Premnadh2024-03-141-0/+8
| | | | | | | Pick-to: 6.6 Task-number: PYSIDE-2640 Change-Id: I03e42470055448d84899f7a167bd1a3dd3f41efc Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Deprecation Python 3.8Cristián Maureira-Fredes2024-03-122-4/+1
| | | | | | | | | | | The changes related PYSIDE-939 can be removed when 3.9 support is dropped, because the problem was fixed and included in 3.9.13 so we cannot assume everyone will be on that version or superior. Change-Id: I78afc660edc6fbb3bb1a2438e17366e63b24e375 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Add documentation on pyside6-projectFriedemann Kleint2024-03-011-1/+2
| | | | | | | Task-number: PYSIDE-1112 Pick-to: 6.6 Change-Id: I9b6b01c9dd45440ce0b2832178b11072d33ba06d Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: list tools with a 2 column gridCristián Maureira-Fredes2024-02-291-28/+120
| | | | | | | | | | | | | | Using a similar grid-approach like the main page (without icons) to present the tools per-category. For the tools that have no page, the link is not generated, so there are no broken hyperlinks. Change-Id: I1a4f43b6e86a56988b5bc53f0592c36e69e55777 Pick-to: 6.6 Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Link more tools from the package details pageFriedemann Kleint2024-02-161-2/+2
| | | | | | | | Pick-to: 6.6 Task-number: PYSIDE-1112 Change-Id: Idec746d10be03174c6ec74e9ad18cb1287385925 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Make Unity builds defaultFriedemann Kleint2024-01-301-2/+2
| | | | | | | | | | [ChangeLog][PySide6] setup.py now uses CMake Unity Build Mode by default. Change-Id: I50c892646c73ac636276460b0a1efa558531c76d 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>
* doc: fix some issues found with rstcheckCristián Maureira-Fredes2024-01-081-2/+2
| | | | | | | | | | 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>
* Shiboken: Remove FindPythonInterp and FindPythonLibs CMake modulesShyamnath Premnadh2023-12-111-1/+1
| | | | | | | | | | | | | | | - They were deprecated since 3.12 and removed in 3.27 - Use FindPython module as replacement - all the Python cmake variables resulted are renamed to their respective variable names as per the FindPython module instead of FindPythonInterp or FindPythonLibs module Pick-to: 6.6 Fixes: PYSIDE-2439 Change-Id: I1d3106e2cc9ee97e2d4f62d4e19e1a591d1021ad Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: remove double white spaceCristián Maureira-Fredes2023-11-211-4/+4
| | | | | | Pick-to: 6.6 Change-Id: I68b835bb5fa00d35fe5406deee2acc83c7bac7cb Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* doc: add tooling section to the main gridCristián Maureira-Fredes2023-11-021-0/+2
| | | | | | | | | This add the existing section to our main grid page, so people can found the information quickly. Change-Id: I7f920c91886ebcd591e1aa5dcaf396af941d56c7 Pick-to: 6.6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* docs: deprecate 'build_rst_docs' in favor of 'build_base_docs'Dennis Oberst2023-10-261-12/+14
| | | | | | | | | | | | | | | | | | | The command for building documentation files has been renamed to 'build_base_docs' and the previous command, 'build_rst_docs', has been deprecated. All relevant occurrences of the command have been updated accordingly. In addition, the documentation config and build directory 'build/pyside6/doc/rst' has been renamed to 'build/pyside6/doc/base'. To ensure a fresh start when generating new documentation, the auto-generated `examples` and `html` directories are now deleted before generating new documentation. This change has been made because these directories are generated anyway, and starting fresh ensures that there are no conflicts or issues with the new documentation. Task-number: PYSIDE-2504 Change-Id: I395ad7e9482b0b68311820d58da362513ebb44b2 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: Add note to avoid Windows Store PythonCristián Maureira-Fredes2023-08-141-0/+3
| | | | | | | | Change-Id: I2683d0e95bdb6fbf22974b117562bcc6edae8d3d Pick-to: 6.5 Fixes: PYSIDE-2405 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: mention --debug option for windows debug buildKeith Kyzivat2023-08-021-0/+2
| | | | | | | | | | | | | | The Windows Getting Started doc page mentions how to build a debug version of PySide6, however it omits that you need to pass the `--debug` option to `python setup.py build`. Mention using `--debug` when building debug. Fixes: PYSIDE-2401 Pick-to: 6.5 Change-Id: I9d5eb1a5e44409f7984f14c5cbf9611efafaf768 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* build: remove traces of distutilsCristián Maureira-Fredes2023-07-142-2/+2
| | | | | | | | | | | | | | | Removed mentions, comments, and fallback usages in some sections of the build scripts and documentation. On the CI, we upgrade setuptools in order to avoid having missing functionality, so it shouldn't be an issue. For Shiboken and CMake, there is still a helper that relies on distutils in case people is using python < 3.8.2 Pick-to: 6.5 Change-Id: Ic33abe9fa8bd8564e9d44c8714b7fedd4e50434a Reviewed-by: Simo Fält <simo.falt@qt.io>
* Tooling: Add qmlcachegenShyamnath Premnadh2023-04-181-0/+2
| | | | | | Pick-to: 6.5 Change-Id: I21ae563efb9488083289c7deb6435ae7e9405049 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Docs: Update version in Getting StartedShyamnath Premnadh2023-04-183-14/+14
| | | | | | | | - Change 6.4 to 6.5 Pick-to: 6.5 Change-Id: I23babc4a6e1b9fd8870ea88cc1cf8423f40e4480 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Link platform dependenciesFriedemann Kleint2023-04-134-1/+10
| | | | | | | Fixes: PYSIDE-2283 Pick-to: 6.5 Change-Id: I01aeb057dba1232ce38ef077d2a2e5e848544e9d Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: update libclang versionShyamnath Premnadh2023-04-123-5/+5
| | | | | | Pick-to: 6.5 Change-Id: Iafd8a0212c8c7059421999ee317c0055883cccc6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Docs: add pyside6-android-deploy to package_details.rstShyamnath Premnadh2023-04-121-1/+4
| | | | | | | Pick-to: 6.5 Task-number: PYSIDE-1612 Change-Id: I279b1e57ce4540a6fbdd4507f2ffcce53ccea267 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: fix issues with pyside rst filesCristián Maureira-Fredes2023-04-055-42/+42
| | | | | | | | | | 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>
* Documentation: Link to the .ui files description from package_details.rstFriedemann Kleint2023-03-301-3/+2
| | | | | | | Pick-to: 6.5 Change-Id: Ic086b05c788bc006d254663b670a8d51d4cbd861 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add hints about intersphinx troubleshootingFriedemann Kleint2023-03-281-2/+13
| | | | | | | | Task-number: PYSIDE-1106 Pick-to: 6.5 Change-Id: Ib58321eb8e433b054aa6a8ce727309cb8cdf551c Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: migrate to sphinx-design and update sphinxCristián Maureira-Fredes2023-03-171-32/+38
| | | | | | | | | | | | | | | | | | | | sphinx-panels is deprecated, and sphinx-design is the better replacement. This patch migrates everything we had in pyside and shiboken, which was useful to remove many CSS related hacks for things we were forcing before. The example gallery was also adapted to generate sphinx-design valid code. Additional adaptation to some examples and files were included as well, which improved the overall example experience. We used this to change to update sphinx as well, which before was not possible to update due to sphinx-panels. Fixes: PYSIDE-2244 Change-Id: Ia3f57f536591ea299bf87302e930203b64fafd7e Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* build_rst_docs: Inform of requirements-doc.txt requirementKeith Kyzivat2023-03-101-3/+3
| | | | | | | | | | Inform user that `pip install -r requirements-doc.txt` should be performed prior to invocation of build_rst_docs target. Task-number: PYSIDE-1106 Change-Id: Icb435fcd592dcd147cd3fb1867349530fae536fc Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: update versions and broken linksCristián Maureira-Fredes2023-02-164-15/+15
| | | | | | | 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>
* Fix documentation on how to pass the source directory for doc buildsFriedemann Kleint2023-02-131-4/+2
| | | | | | | | | | | | It seems the querying of the environment variable is not implemented by d4764a4c514ec15f4cd680143cbd189482af6251. Pick-to: 6.4 Fixes: PYSIDE-2227 Task-number: PYSIDE-1067 Change-Id: Ib0bf038aee4d783ec303af1a5feeb5810911f812 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Keith Kyzivat <keith.kyzivat@qt.io>
* doc: use icons for the platform guidesCristián Maureira-Fredes2023-01-051-14/+32
| | | | | | | | | | | The links were broken, and also they were not highlighted enough for people to understand they were clickable, and that they should visit them for platform specific instructions. Change-Id: I848b394eac915889f9483dcc56893204dc43ab85 Pick-to: 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* build: split requirement.txt for docsCristián Maureira-Fredes2023-01-041-6/+9
| | | | | | | | | | | | | | | | | Removing the documentation packages from the main requirements.txt file, and adding a mention on the documentation to install the modules from the new requirements-doc.txt file. Additionally, dataclasses was removed from the requirements because it's a feature included in Python 3.7+ [ChangeLog][PySide6] To build the documentation, you need to install also the new requirements-doc.txt file Pick-to: 6.4 Change-Id: I2f6a5cc2f05a7a2e89d3aa06d18791a13a8127b4 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Mention Unity build modeFriedemann Kleint2022-12-201-0/+3
| | | | | | | Task-number: PYSIDE-2155 Change-Id: I1cdcbc8aa7500d685a138a3352632635519e323a Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add some hints for debug builds on WindowsFriedemann Kleint2022-12-121-0/+15
| | | | | | | Pick-to: 6.4 6.2 Change-Id: Ice4a0915cc5d53bf62d25f082318cff95c782856 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: qmlimportscannerShyamnath Premnadh2022-11-101-0/+2
| | | | | | | | - Adds a short description for qmlimportscanner Pick-to: 6.4 Change-Id: I9ce9332ea0b02281bd33291b4dccaff1afd94ebd Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix up the documentation generation instructionsFriedemann Kleint2022-11-081-4/+7
| | | | | | | | | | The manual still mentioned sphinx_tabs, which conflicts with sphix-panels. Pick-to: 6.4 Change-Id: I24e6ca11f0d3de4ddc8c69534c1d325fe9f1e523 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: order the sidebar contentCristián Maureira-Fredes2022-11-037-0/+1044
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>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-17 18:42:09 +0000