aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/api.rst
Commit message (Collapse)AuthorAgeFilesLines
* Update API (front page) module documentationFriedemann Kleint2024-10-011-18/+20
| | | | | | | | | | | | | Fix titles and wording according to qtdoc..qtmodules.qdoc (similar to bc87b5d3319d758827edcdff2798777bcf36ae6b). Add the Quick Controls module to the API page. In the Quick Controls module page, add the list of controls/QML types. Task-number: PYSIDE-1112 Change-Id: Ie68e00e8eac9194142e3d1625c72557455bc68c6 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>
* doc: migrate to sphinx-design and update sphinxCristián Maureira-Fredes2023-03-171-40/+20
| | | | | | | | | | | | | | | | | | | | 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: order the sidebar contentCristián Maureira-Fredes2022-11-031-3/+5
| | | | | | | | | | | | | | 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: replace api module table with panelsCristián Maureira-Fredes2021-11-101-22/+52
| | | | | | | | | | This fix the warnings introduced by a previous change. Pick-to: 6.2 Change-Id: Ie25db8f8e466103487cda9ca4032bd75fab69e7b Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: general update and add more informationCristian Maureira-Fredes2021-02-041-50/+7
| | | | | | | | | | | | | | | | | | | | | | | | | 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>
* Rename PySide2 to PySide6Friedemann Kleint2020-11-021-0/+90
Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I845f7b006e9ad274fed5444ec4c1f9dbe176ff88 Reviewed-by: Christian Tismer <tismer@stackless.com>