aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc: enable snippets translate toolCristian Maureira-Fredes2021-03-26518-40878/+21
| | | | | | | | | | | | | | | | | Create snippets directories in case they don't exist. Add "-q" option as the examples directory to keep the "--quiet" option from the build. Something to consider with this patch: Removing all the previous old snippets, which include not only 'cpp' files, but also '.h', '.qdoc', '.qrc', '.png', and '.qml', which might be used in the snippets, but will need to be updated in the generation tool, to not translate, and copy them over. Change-Id: Icbef9e1c93a12b90dbcfa990ef055ca6f8868407 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> (cherry picked from commit 9a4fb2eb72040aeadf6124ec1cad083859ac0787) Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix missing doc snippetsFriedemann Kleint2021-03-261-3/+9
| | | | | | | | | | | Ensure doc snippets are copied to the build directory by creating a separate target. Amends 93ae3d9b38649e9d683a658a6a19b7623083f5a0. Change-Id: Idfd3b55e79769fdceda64ee29bffae801eb9055b Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit d6611611d65ef4759eda203657300d513f118c86) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Improve deployment documentationFriedemann Kleint2021-03-224-0/+54
| | | | | | | | | | | | Extend the table by the Qt version. Add some chapter on Qt 6 support. Add some description for py2exe. Task-number: PYSIDE-1112 Change-Id: Ic3a9fb76d9c13017a107f083da4c7ed326d64e5c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 80aec29aca246f1f67a4f8c453b49f1eadfee6fd) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Improve Porting documentationFriedemann Kleint2021-03-191-6/+68
| | | | | | | | | Task-number: PYSIDE-1112 Task-number: PYSIDE-1482 Change-Id: Ic65d86e2567849f26cb28c480937e7fb41ad5856 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 9e02cd78a871f0e1c2dd855433ab750d6fe81c09) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* doc: migrate qdoc approach to document examplesCristian Maureira-Fredes2021-03-1712-203/+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 Change-Id: I239a24fa4e4f970540857ba8b33b9b13c18142b1 Reviewed-by: Christian Tismer <tismer@stackless.com> (cherry picked from commit d97aedf37809c479ab409c4247b60c0cfcef35d6) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* doc: add sphinx-panels to the documentationCristian Maureira-Fredes2021-03-176-35/+124
| | | | | | | | | | | | | | | | | | | | | | | 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 Change-Id: Id19be92e72f0a18f63b76daf1898080f3e199626 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> (cherry picked from commit 4750fbcb8e5d1f0137a8660ffa77f595dac46504) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* doc: example gallery show code in tabsCristian Maureira-Fredes2021-03-031-1/+2
| | | | | | | | | | | | | | | | Before this patch, the auto-generated documentation page had all the files from the .pyproject listed one after the other. This uses a new sphinx extension called sphinx-tabs https://github.com/executablebooks/sphinx-tabs which allows us to easily add content in tabs. Task-number: PYSIDE-1112 Change-Id: Ibd66a8c911f05be13ae2700be6d3e95a2b98b775 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit a7c7c729a388b0a4e0e104fac1130feb6e03151b) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Documentation build: Avoid re-running qdoc/shiboken every timeFriedemann Kleint2021-02-262-25/+39
| | | | | | | | | | | | | | | | | | | | | | 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. Change-Id: I00033e6f1034a5fdc534a0f2fee018268e2e482a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 1251fb08619e030665651ea965c1ee6c283b9913) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* PySide6/Documentation: Fix QmlElement.rstFriedemann Kleint2021-02-151-2/+4
| | | | | | | | | | | Change the snippets to be Python code, fixing: QmlElement.rst:28: warning: Definition list ends without a blank line; unexpected unindent. Change-Id: I98fa640e206199a466fa9aa8b5df3363fe118f69 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit a47c2618139fdb5c63e4614fe164a63d30f32fa8) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Documentation: Add the modules contained in other qddocconf filesFriedemann Kleint2021-02-151-0/+6
| | | | | | | | | | | This will fix the currently dead links to OpenGLWidgets SvgWidgets in 6.0 and handle the modules new in Qt 6.1. Task-number: PYSIDE-1482 Change-Id: If087b272b3bfd70e726c4f0b86ea679ad7241d76 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 0d43f0eae4071ceffa07ec6c89349fa7942699a8) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Fix the example_gallery quiet option for quiet modeFriedemann Kleint2021-02-151-1/+1
| | | | | | | | | | | | Use the right quotes. Amends 9f8fc934818c3ae7473fe6258056bc7c7bf9f718. Task-number: PYSIDE-1490 Change-Id: I9e5c999747ab96056180692c34c129e399915e56 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 6f6f9495a8f18408fbc233c1d889549fbb8567f9) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* fix example_gallery quiet optionCristian Maureira-Fredes2021-02-121-1/+0
| | | | | | | | | | Passing '' was generating an error, so we don't set the variable so we don't pass empty quotes to the script. Change-Id: I672117d43ccd80ca3a625f590556b25a006514c6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> (cherry picked from commit f23cbd1c5fd8315569440bcdcd3eee2a30fd0392) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Silence the example_gallery toolFriedemann Kleint2021-02-101-1/+5
| | | | | | | | | | Add a --quiet option and use that for quiet builds. Task-number: PYSIDE-1490 Change-Id: I6b8a3fa159acb85dee5fbc064991a09a9fa6ceda Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 9f8fc934818c3ae7473fe6258056bc7c7bf9f718)
* doc: fix responsiveness of the pageCristian Maureira-Fredes2021-02-101-6/+55
| | | | | | | | | | | | Adding some cases to properly show the page on mobile devices. Fixes: PYSIDE-1498 Change-Id: Ia8ee234d09e5246745706f5b6aca29fe31075c04 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 19bc892133ada1ceae68eb42ce330e2599e2ec33) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* doc: use example gallery tool in build processCristian Maureira-Fredes2021-02-102-14/+13
| | | | | | | | | | | | | | | | This enables the gallery generation tool in the CMake-based process in charge of building the documentation. The old 'index.rst' file was removed, and rules were added to the .gitignore to avoid adding the generated files. Fixes: PYSIDE-1490 Change-Id: I71a5a9e34ce18f42dbc7af8a3e4be65924a79d67 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com> (cherry picked from commit 75a50de5787fbc14a9183e50b10cd3a57495ec1d) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* doc: add tool to generate examples galleryCristian Maureira-Fredes2021-02-091-2/+6
| | | | | | | | | | | | | | | | | | | | | | This script generates a gallery for all the example currently in pyside-setup/examples. Using this tool will overwrite the index rst file for the examples located in 'sources/pyside6/doc/examples/index.rst Additionally, to display the code of each example, this will generate one extra .rst file for each example that contains a .pyproject file, for example: 'sources/pysides6/doc/examples/example_widgets__tetrix.rst' Currently, the usage of this tool is not incorporated in the documentation building process. Task-number: PYSIDE-1490 Change-Id: I78546d4c7905fd8b521f4112457980b4d1d56860 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> (cherry picked from commit e8eac85a5db8386689ffe174694f82c1e5dad854) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* PySide6/Documentation: Update the getting started page on doc buildFriedemann Kleint2021-02-091-1/+6
| | | | | | | | | | Mention ninja and how to re-run sphinx. Task-number: PYSIDE-841 Change-Id: Id169da66dcfd09640800da52661dbd842b74f15b Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 13e63be261a89ed9c051028225d63a30b1f005af) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* doc: general update and add more informationCristian Maureira-Fredes2021-02-0427-248/+839
| | | | | | | | | | | | | | | | | | | | | | | | | | 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 Change-Id: I5195cc5a4af858bb7aad7891d14562ca07b6df23 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> (cherry picked from commit a6c7e9d7fd65946762766e40793ba86291bcca1a) Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PySide6: Fix documentation warning in qmlsqlintegration.rstFriedemann Kleint2021-02-021-1/+1
| | | | | | | | | | Fix sources/pyside6/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst.rst:65: WARNING: line number spec is out of range(1-145): '130-146' Change-Id: I66b328f03fb69048defd1e1da1dfda8d8c309d96 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 4d7c6e0ac10dc49abb7e7d4ad07503449906f459) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Documentation: Fix creating inheritance diagramsFriedemann Kleint2021-01-221-1/+1
| | | | | | | | | Amends d9f344fcef6bec04a787f9ea9f4ea94f15eaa26c. Change-Id: I14a440c8372b5d0e418161c593bf9093f9010665 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 665f3b2ba6014575185d9209229df35d2d5b9798) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* sources: migration from format() to f-stringsCristian Maureira-Fredes2021-01-0633-85/+83
| | | | | | | | | | This should be the last patch related the usage of f-strings from the 'sources' directory. Change-Id: I0288d720dc4930dee088ca3396a66d1b3ba18f76 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> (cherry picked from commit d9f344fcef6bec04a787f9ea9f4ea94f15eaa26c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* doc/tests: update old style printCristian Maureira-Fredes2021-01-0432-82/+82
| | | | | | | | | | There were some leftovers from Python 2 still around our code, this patch only covers the 'print' cases. Change-Id: Icf574be6a40cdb233d3c410c2ec831d2d09bb735 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit b3a8c9898cca52b63d270a54651ec71de9b32238) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Porting Guide: Mention classes that were movedFriedemann Kleint2020-12-151-0/+4
| | | | | | | | | Amends 592a716369d2cdacb423b8abc29045b1d1535991. Change-Id: I73c6ab49e157d16bc9e3532e33d2ec05ba541682 Reviewed-by: Christian Tismer <tismer@stackless.com> (cherry picked from commit 3a02acaceb36e2de4b5c61e1b607850630c82c9c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Add a small PySide2 porting guideFriedemann Kleint2020-12-093-0/+34
| | | | | | Change-Id: Id030c46e56b24df02e8b946768c3deb1e09427a1 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: Update references to Qt6Cristian Maureira-Fredes2020-12-0913-143/+102
| | | | | | | | | | | * 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>
* Fix sphinx warning in QtCore.Property.rstFriedemann Kleint2020-11-261-0/+1
| | | | | | | | | Fix doc/rst/PySide6/QtCore/Property.rst:3: WARNING: Explicit markup ends without a blank line; unexpected unindent. Pick-to: 5.15 Change-Id: I20311655899df17313aa657c0b93c9d488f3b5c8 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* python3: remove all obsolete "from __future__" import statementsChristian Tismer2020-11-092-3/+1
| | | | | | | | | | | Note that not all future statements can be removed: PEP 563 for instance deals with from __future__ import annotations Task-number: PYSIDE-904 Change-Id: Ia387ec87f3c68ca64d13e8e80191eda900f58638 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Rename PySide2 to PySide6Friedemann Kleint2020-11-02743-0/+57989
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 2024-05-09 06:26:54 +0000