aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* doc: add tools recommendations for examplesCristián Maureira-Fredes2023-04-071-1/+16
| | | | | | | | | | Including a reference to flake8 and ruff to find issues with the code styling of the new examples, and encouraging users to use isort to order imports. Change-Id: I128a0d2712d10f39a1debe49bfdb16f24690e493 Pick-to: 6.5 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: fix issues with pyside rst filesCristián Maureira-Fredes2023-04-0530-567/+543
| | | | | | | | | | 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: fix shiboken format inconsistenciesCristián Maureira-Fredes2023-04-041-75/+75
| | | | | | | | | | There were many unnecesary tabs, extra new lines, and missing grave accents in the shiboken documentation, that were generating a strange rendering. Pick-to: 6.5 Change-Id: Ic6040fe148a2a748c893e6577d336620e031d165 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Brush up the expenses tutorialFriedemann Kleint2023-04-0413-324/+168
| | | | | | | | | | | | | | | The snippet line numbers were not correct after the license change. Take the opportunity to fix up the code: - Use super() - Use a QFormLayout for the input fields - Remove the Quit button, which duplicates the menu action - Streamline code Pick-to: 6.5 Fixes: PYSIDE-2277 Change-Id: Id295573dbaf07557ca356eff83f4913753efb174 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@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>
* docs: add extendedexplorer tutorialDennis Oberst2023-03-3033-0/+1732
| | | | | | | | | | | | | | Extended the filesystemexplorer example with interactive scheme switching and wrote a tutorial about it. This tutorial uses Qml features from 6.5. The tutorial is intended to provide users with an overview of how to create modern applications with PySide/QtQuick Pick-to: 6.5 Task-number: QTBUG-108289 Task-number: PYSIDE-2224 Change-Id: I114824680156d0eacbbfe3363c67d1d5784a2219 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: use new logo and colorsCristián Maureira-Fredes2023-03-253-10/+10
| | | | | | | | | | | | | | | | | This updates the branding of the docs to the new guidelines in Qt. The neon green was updated to #2CDE85, and for the light version of the docs, because of the contrast Midnight was used #27138B (Pine, and Moss didn't work well) The Qt for Python logo was updated as well. Change-Id: I2cf556d5c3b3c9c84923204f3c2e829ab1f68f54 Pick-to: 6.5 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: migrate to sphinx-design and update sphinxCristián Maureira-Fredes2023-03-1711-829/+578
| | | | | | | | | | | | | | | | | | | | 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: adjust usage of -uic and -rcc toolsCristián Maureira-Fredes2023-03-163-4/+4
| | | | | | | | | | We encourage people to use the option '-o' rather than '>' to avoid having output messages inside the generated file. Change-Id: Ie45303265c8f391c4e54e0e2af9d7e810a0797aa Pick-to: 6.2 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@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: add zip file with examples to downloadCristián Maureira-Fredes2023-03-091-0/+28
| | | | | | | | | | | This adds a new functionality to the example gallery tool to create a ZIP file containing all the example files, and including a button to download it on each example page. Change-Id: I703c1d73bf690f2eaafca1012ccce3947e13a245 Task-number: PYSIDE-2246 Pick-to: 6.4 6.2 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add overviews from qtdoc to index pageFriedemann Kleint2023-02-221-0/+7
| | | | | | Task-number: PYSIDE-2225 Change-Id: I1ed36000a2d8685743725704ccd913147e5b98f4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix documents pages from qtdocFriedemann Kleint2023-02-201-23/+21
| | | | | | | | | | A number of qdoc files actually have different output pages (\page directive). Amends 42ca6a9b8a04eef15fc03c4aa9c32cfb2ca10ab5. Task-number: PYSIDE-2225 Change-Id: I1a072f47de8590ec1e79fbdaba3d52d95930692c Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add some documents from qtdocFriedemann Kleint2023-02-161-0/+55
| | | | | | Task-number: PYSIDE-2225 Change-Id: I32134df0f777422871430393766f3eff9084e3e0 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add the qtdoc moduleFriedemann Kleint2023-02-162-0/+7
| | | | | | | | | | There are no Python bindings for the qtdoc module, yet it contains important documents. Add it to the qdoc step. Task-number: PYSIDE-2225 Change-Id: I8fcd938722bd131d36f793d245943d01c879b39a Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: update versions and broken linksCristián Maureira-Fredes2023-02-1611-24/+25
| | | | | | | 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>
* Add license headers to cmake filesFriedemann Kleint2023-02-161-0/+3
| | | | | | | | | | | | CMakeLists.txt and .cmake files of significant size (more than 2 lines according to our check in tst_license.pl) now have the copyright and license header. Task-number: QTBUG-105718 Task-number: QTBUG-88621 Change-Id: I98bd2e80f182d8bf7aef6b633f37a428e2dac69b Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Kai Köhne <kai.koehne@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>
* 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>
* Docs: Fix misplaced section in feature-motivation.rstFeRD (Frank Dana)2023-02-061-5/+5
| | | | | | | | | | | Commit 9b5fa60d1fed5025e97c393ba1bab80f81ba833a added the section "Using __feature__ with UIC files" to the doc, but mistakenly inserted it between the previous section and the code block which followed it. Change-Id: I56ae37bf3373c110b0f1e4bb342cd6df27b0d68c Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: fix build warningsCristián Maureira-Fredes2023-02-032-1/+2
| | | | | | | | | Issues were found related to images, indentation level, and old references. Pick-to: 6.4 Change-Id: Idb343d4b3660ec44148fffd2de978ea868c56e90 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* shiboken: optionally de-virtualize the Python filesChristian Tismer2023-01-171-0/+17
| | | | | | | | | | | | | | | | | | | | The Python files in Shiboken are completely virtualized. That means: There is no interaction with the external world that could create interferences. For debugging purposes or to modify the embedded files, it is anyway useful to have an option to materialize these files in the file system, again. We add an environment variable `SBK_EMBED` that explicitly unpacks the Python files (SBK_EMBED=0) or explicitly removes the unpacked files (SBK_EMBED=1). Without this variable, the state of embedding remains the same. Change-Id: I1081b0f910482fb4b80a02f72c6bcce060db38e6 Fixes: PYSIDE-1994 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add note stating that QApplication is required for the Qt ↵Friedemann Kleint2023-01-091-0/+4
| | | | | | | | | Charts QML types Pick-to: 6.4 6.2 Task-number: PYSIDE-2179 Change-Id: Ic7ab5681fce56202eda89e6aa22ad589549f70bf Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: change order of main menuCristián Maureira-Fredes2023-01-051-20/+20
| | | | | | | | | | moving the commercial page to the first row Pick-to: 6.4 Change-Id: Ie2a2c57ae6a738b12252b3a58467d638393a5c2f Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: use icons for the platform guidesCristián Maureira-Fredes2023-01-054-14/+146
| | | | | | | | | | | 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>
* Deploy tool documentationShyamnath Premnadh2023-01-042-3/+166
| | | | | | | | | | - Supplement the deployment documentation with pyside6-deploy - Demonstrates the various ways one can use the tool Pick-to: 6.4 Change-Id: I02e168d1857d6d09e774507bc24506fd6fe84b9f Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Doc: Fix path to qtquickcontrols documentation projectTopi Reinio2022-12-291-2/+2
| | | | | | | | | | | The '2' suffix has been dropped from the directory name in the source. Also fix the include path which was pointing to a non-existing directory. Change-Id: Ib8383e71d5690a6ec6e764cf334c320ab0a767e9 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Exclude all README.md files from being processed by SphinxDennis Oberst2022-12-201-1/+1
| | | | | | Change-Id: I879f439f7f1b992b7f2528392582ff27cc76e80c Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add the Quick custom geometry exampleFriedemann Kleint2022-12-201-1/+0
| | | | | | Task-number: PYSIDE-1345 Change-Id: I7000878e3b2e83570653ca10ba084e133fec3cce Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@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>
* Add Markdown support to SphinxDennis Oberst2022-12-191-2/+21
| | | | | | | | | It is now possible to write documentation in markdown which gets processed by the MyST - Markdown Parser. Change-Id: Id17eae32d2ad2b6895e2f8c406a4215b8316b4e1 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: adjust CSS of pyside and shibokenCristián Maureira-Fredes2022-12-162-2202/+4
| | | | | | | | | Fixing discrepancies between the qt_style files, and removing an outdated CSS file. Change-Id: Id89125cc38f0ff8375a284bd64effd1372901df2 Pick-to: 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: clean sphinx configurationCristián Maureira-Fredes2022-12-161-3/+1
| | | | | | | Change-Id: Ic39b76a58ac9fac1ea4159c4aafd0ab05db38901 Pick-to: 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* doc: improve color contrastCristián Maureira-Fredes2022-12-161-5/+5
| | | | | | | | | | | | changing colors to improve the contrast of the light and dark version of the documentation. Change-Id: I4b68cf0d59e1db9da1d55de47b808a314b5504d1 Pick-to: 6.4 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: fix broken gettingstarted linksCristián Maureira-Fredes2022-12-153-5/+5
| | | | | | Change-Id: I9471df621335ea1ecc967109ec8a5642bc85b0cf Pick-to: 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Add some hints for debug builds on WindowsFriedemann Kleint2022-12-122-0/+17
| | | | | | | 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>
* doc: update dataviz URL to download all the codeCristián Maureira-Fredes2022-11-251-1/+2
| | | | | | | | | | The file was removed, and it's better to provide a direct URL to the repo location Pick-to: 6.4 Change-Id: I78a4c2fd71b6f9a8032c16541871584bf9327ca3 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: new titles for getting started and quickstart pagesCristián Maureira-Fredes2022-11-251-3/+3
| | | | | | | | | Motivated by the feedback on where people need to go first. Pick-to: 6.4 Change-Id: Ic30a6d5d7682148a405ac0a1d016e28dc4f4328b Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: move the FAQ out of tutorialsCristián Maureira-Fredes2022-11-2512-70/+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: fix gettingstarted broken linkCristián Maureira-Fredes2022-11-251-1/+1
| | | | | | | | | | | | Due to the structure change, one needs to specify the index of the directory, currently it was looking for 'gettingstarted.rst' to generate the index, but it is 'gettingstarted/index.rst' Pick-to: 6.2 6.4 Change-Id: Ia47900f42726505ff28d02451549668124428b4c Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Developer Documentation - Modify add qt wrapper toolShyamnath Premnadh2022-11-181-1/+1
| | | | | | | | - Instead of config.py the tool comes from __init__.py now Pick-to: 6.4 6.4.1 Change-Id: I58530d067c6b9fd238ad184b44cad710d2ff6801 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: skip shiboken execution for rst doc buildCristián Maureira-Fredes2022-11-161-0/+2
| | | | | | | | | amends cc0481a46f801473c3dbabe855534a7aa034443f Change-Id: I7c59905a290a05c0cb4873419316cd450a0fa34c Pick-to: 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* doc: add commercial pageCristián Maureira-Fredes2022-11-108-0/+222
| | | | | | | | | | | | 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>
* 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>
* CMake: Execute shiboken with appropriate PATH on WindowsAlexandru Croitor2022-11-091-14/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously one had to add the Qt bin dir and libclang.dll dir to PATH manually to ensure shiboken successfully runs when building Qt for Python using CMake without setup.py. This should not be necessary though, because the build system knows where Qt is (usually via the --qtpaths option) and where libclang is (via LLVM_INSTALL_DIR and friends). Introduce a CMake function that generates a batch shell script wrapper for a given tool. The wrapper will have PATH set to the Qt bin dir and libclang dir. Generate such a wrapper for shiboken and use it everywhere we call shiboken to generate bindings. The wrapper is only created on Windows. All mentions of Shiboken6::shiboken in custom commands now need to be wrapped in $<TARGET_FILE> because automatic target path conversion only happens if the target appears as the first argument to a custom command, and that is not the case anymore with the wrapper script being at the front. As a drive-by, the indentation of custom commands is now adjusted for easier readability and to conform with the indentation used in the Qt build system. Pick-to: 6.4 Fixes: PYSIDE-1844 Change-Id: I287adeedf234d0272c2963e96ae2aa5c4c0f0c83 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix qtattributionsscannertorst to not require Qt in PATHFriedemann Kleint2022-11-092-11/+29
| | | | | | | | | | | | | | Previously, the tool used qtpaths to find the Qt libexec dir. This can fail when building against a system Qt version on Linux, finding a Qt 5 version. Pass the Qt libexec dir from CMake and change the fallback to use qtpaths6. Pick-to: 6.4 Task-number: PYSIDE-1106 Change-Id: I6789d3628370e38e176f216b3d7ebfedd3b1d9b7 Reviewed-by: Christian Tismer <tismer@stackless.com>
* 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>