aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/quickstart.rst
Commit message (Collapse)AuthorAgeFilesLines
* doc: clarify the commercial and lts releasesCristián Maureira-Fredes2023-12-201-0/+2
| | | | | | | Fixes: PYSIDE-2558 Pick-to: 6.2 6.5 6.6 Change-Id: Ia606fe3b5734927c296ca89df674ef9cd1615b22 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@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: clarify issue with Qt installationsCristián Maureira-Fredes2023-05-241-13/+24
| | | | | | | | | | | | | | This arose from many similar comments from people new to Python, and wondering about the role of having Qt installed in the system. Additionally, some of the Qt-classes references in the file were not linked to the actual documentation page, so the usage of :ref: rather than :code: is encouraged. Pick-to: 6.5 Change-Id: I3d5560a49b7a89507aa8774771f4a6acacb67d6b Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: fix issues with pyside rst filesCristián Maureira-Fredes2023-04-051-4/+4
| | | | | | | | | | 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: migrate to sphinx-design and update sphinxCristián Maureira-Fredes2023-03-171-39/+32
| | | | | | | | | | | | | | | | | | | | 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>
* 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>
* Add a QML quick start exampleFriedemann Kleint2023-02-161-2/+74
| | | | | | | Fixes: PYSIDE-2225 Pick-to: 6.4 Change-Id: I13ed179678b0ef726e72c3e693e8b451c56b26d7 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Fix broken Qt prefix for conda installsAdrian Herrmann2023-02-141-0/+7
| | | | | | | | | | | | If PySide6 is installed through Anaconda, it will conflict with Anaconda's own Qt package, which is based on Qt 5, creating a version mismatch. To work around this, if PySide runs in a conda env, register an internal qt.conf setting the prefix value to the corresponding path in site-packages. Pick-to: 6.4 Change-Id: I5639d7eeaf524a8a4aa533dc5a83bdb0c74cbd9f Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: move the FAQ out of tutorialsCristián Maureira-Fredes2022-11-251-12/+86
| | | | | | | | | | | | After feedback that the common questions are not really tutorials, they are now moved at the end of the 'quickstart' page, so people can understand concepts and the scope of the project just after doing a hello-world application. Pick-to: 6.4 Change-Id: Ib6757292ff3d30d560dd99d36a6a047653039c5d Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: add commercial pageCristián Maureira-Fredes2022-11-101-0/+2
| | | | | | | | | | | | The goal of this page is to clarify the installation process for commercial users, the migration from OSS and previous versions, to briefly explain the Python development workflow and virtual environments, and the integration with Qt Creator. Change-Id: I1a7fe4f46404aaac15838e49bff0148d3cb36f43 Pick-to: 6.4 Fixes: PYSIDE-2096 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: order the sidebar contentCristián Maureira-Fredes2022-11-031-2/+2
| | | | | | | | | | | | | | 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>
* Documentation: Update versions for 6.4Friedemann Kleint2022-09-131-1/+1
| | | | | | | | 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>
* doc: add package detail pageCristián Maureira-Fredes2022-07-081-0/+3
| | | | | | | | | | | | 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>
* 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>
* Purge remaining app.exec_()Friedemann Kleint2021-05-171-1/+1
| | | | | | | | Add a porting note. Pick-to: 6.1 Change-Id: I4ccb1dc2a3a5925e55e94e7f3d23b1fb199afe4a Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: migrate qdoc approach to document examplesCristian Maureira-Fredes2021-03-171-1/+1
| | | | | | | | | | | | | | | | | There were two previous documented examples using the approach based on qdoc: stardelegate, and classwizard. This patch moves them into the 'doc/' directory for each example, and partially revert the changes from 308157f01260c640e21f6972619d3b380c007acb Additionally, an unrelated screenshot was moved to a new general 'images/' directory. Task-number: PYSIDE-1112 Pick-to: 6.0 Change-Id: I239a24fa4e4f970540857ba8b33b9b13c18142b1 Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: general update and add more informationCristian Maureira-Fredes2021-02-041-53/+60
| | | | | | | | | | | | | | | | | | | | | | | | | 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>
* doc: Update references to Qt6Cristian Maureira-Fredes2020-12-091-7/+2
| | | | | | | | | | | * 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/+118
Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I845f7b006e9ad274fed5444ec4c1f9dbe176ff88 Reviewed-by: Christian Tismer <tismer@stackless.com>