aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/gettingstarted.rst
Commit message (Collapse)AuthorAgeFilesLines
* Fix trailing empty linesFriedemann Kleint2024-12-131-1/+0
| | | | | | Pick-to: 6.8 Change-Id: I1a5964463f703ade0657816cb974206355a5ae5b Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: Avoid same name for directory and main qml fileCristián Maureira-Fredes2024-11-111-3/+3
| | | | | | | | | | | | | | | | | | Discovered while testing deployment on macOS, nuitka fails when the directory and file (e.g. Main/Main.qml) have the same name. This might be able to be fixed by other arguments or even upstream in Nuitka, this is a simple change that will encourage people not to use the same name in the meantime Pick-to: 6.8 Fixes: PYSIDE-2919 Task-number: PYSIDE-2910 Change-Id: I596d820e4a30996f9cf934a9f93e6436e51ad0d2 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: improve a bit the gettingstarted pageCristián Maureira-Fredes2024-08-281-31/+72
| | | | | | | | | | | | | | | Add explanation of Qt Widgets and Qt Quick, remove outdated information, and move the notes around where they make more sense. Add a banner for both technologies, and adding a screenshot of the Quick example. At the end, add a section to point the readers to the Examples and Tutorials sections. Change-Id: Ie3b1856b7150a83633f9747a22057d902fb44b48 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>
* Docs: Use sphinx reference in gettingstarted.rstShyamnath Premnadh2024-08-141-6/+12
| | | | | | | | | | - update relative paths to use sphinx cross references. This ensures more robust documentation which is easier to maintain and these cross references can be reused. Task-number: PYSIDE-2837 Change-Id: I027073793f8344e0e0599d0441449833d536cdcc Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Rearrange sectionsShyamnath Premnadh2024-08-121-0/+295
| | | | | | | | | | | | | | | | | | | | | - 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>
* doc: order the sidebar contentCristián Maureira-Fredes2022-11-031-516/+0
| | | | | | | | | | | | | | 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: 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>
* 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>
* Documentation: Update versions for 6.4Friedemann Kleint2022-09-131-3/+3
| | | | | | | | 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>
* Update documentationFriedemann Kleint2022-09-121-9/+3
| | | | | | | | | | - 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>
* 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>
* doc: skip the documentation build by defaultCristián Maureira-Fredes2022-04-091-2/+9
| | | | | | | | | | | | | This reverse the current approach of building the documentation by default, and replace the skip-docs parameter by a build-docs one. A warning is printed when the --skip-docs is used, and another warning is displayed when using --doc-build-online without the --build-docs option. Change-Id: I2bf8302881b51e9831795a7e881b106022cdffa8 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: Add cross compilation guideCristián Maureira-Fredes2022-04-021-0/+252
| | | | | | | | | | | | This guide is based on the commit message from the change that introduced the option to use setup.py to cross compile Shiboken (module) and PySide, plus additional information to configure all the requirements to start the process. Fixes: PYSIDE-1810 Task-number: PYSIDE-802 Change-Id: I03e1b803a809010bc3acd350b518b3c46741619e Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* doc: change http by httpsCristián Maureira-Fredes2022-04-011-1/+1
| | | | | | Pick-to: 6.2 Change-Id: Id796694e947643152dc0d57dd760efb89ddd8f16 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Remove mentions of qmakeFriedemann Kleint2022-02-081-4/+4
| | | | | | | | | It is replaced by qtpaths. Pick-to: 6.2 Task-number: PYSIDE-1814 Change-Id: I0aafa0a8ebfc6fc9fe4eb4887dc740c9ea0e5767 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Fix platform note on getting started pageFriedemann Kleint2021-10-211-4/+3
| | | | | | Pick-to: 6.2 Change-Id: I0027bd16aa0b5dea6bd51fb3b0df1b5cfb605388 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PySide6: Add some information on the toolsFriedemann Kleint2021-06-171-0/+2
| | | | | | Task-number: PYSIDE-1378 Change-Id: I9433fd3b1d4d09c6a7d961d67c103ccd651e5beb Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: add sphinx-panels to the documentationCristian Maureira-Fredes2021-03-171-3/+3
| | | | | | | | | | | | | | | | | | | | | | This plugin replaces sphinx-tabs, so that's removed. The panels plugin will add bootstrap responsive cards to the docs allowing us to use them instead of the ad-hoc table we had. Additionally, this changes the example gallery tool too, since the main gallery was built using our own table implementation. Since Panels also provides options to add content in tabs, with CSS instead of JS (from sphinx-tabs), we update the generated examples files. Fixing warning messages related to files that didn't exist, duplicated references, and redundant indexes. Task-number: PYSIDE-1112 Pick-to: 6.0 Change-Id: Id19be92e72f0a18f63b76daf1898080f3e199626 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation build: Avoid re-running qdoc/shiboken every timeFriedemann Kleint2021-02-261-2/+13
| | | | | | | | | | | | | | | | | | | | | The qdoc and shiboken steps take quite a long time when rebuilding the documentation. Similar to the generator dependency on mjb_rejected_classes.log (see CMake macro create_generator_target_library_name / sources/cmake_helpers/helpers.cmake:262)), turn the qdoc/shiboken targets into custom commands producing specific files (qtcore-index.webxml, QtCore/index.rst). This prevents the commands from being re-run as long as the files exist and are not outdated. Adapt the documentation. Pick-to: 6.0 Change-Id: I00033e6f1034a5fdc534a0f2fee018268e2e482a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PySide6/Documentation: Update the getting started page on doc buildFriedemann Kleint2021-02-091-1/+6
| | | | | | | | | Mention ninja and how to re-run sphinx. Pick-to: 6.0 Task-number: PYSIDE-841 Change-Id: Id169da66dcfd09640800da52661dbd842b74f15b Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: general update and add more informationCristian Maureira-Fredes2021-02-041-36/+48
| | | | | | | | | | | | | | | | | | | | | | | | | Updates: * Refreshing the information on installing and building PySide * Adding hyperlinks to some files * Including PySide installation GIF (from Wiki) * Modifying the CSS to improve the code snippets, :command: role, and adding layout for two columns. New tutorials * QTableWidget * QTreeWidget New documentation * Differences between Widgets and QML * IDE information (+ QtCreator GIF from Wiki) * When to use Shiboken * file types explanation * Summary on distributing applications Pick-to: 6.0 Change-Id: I5195cc5a4af858bb7aad7891d14562ca07b6df23 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Bump CMake versionFriedemann Kleint2020-12-101-1/+1
| | | | | Change-Id: I828e56b29bb0afa4fcc4d4952cc7151d826c4afc Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: Update references to Qt6Cristian Maureira-Fredes2020-12-091-12/+11
| | | | | | | | | | | * 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/+218
Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I845f7b006e9ad274fed5444ec4c1f9dbe176ff88 Reviewed-by: Christian Tismer <tismer@stackless.com>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-18 17:26:38 +0000