aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/conf.py.in
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: Use a collapse directive for the detailed class descriptionFriedemann Kleint2025-09-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | Traditionally, the class pages were modelled after the Qt C++ documentation. There was a brief description, ending with a reference to the detailed explanation, labelled "more..". While this actually works in sphinx, too, it starts to emit warnings about multiple definitions of the 'more' label. To fix this, introduce a sphinx collapsible directive, expanding to the detailed description. This however only works unless the detailed description has headlines (for example, for QObject). This creates a difference in that the detailed description is always initially hidden, but it is assumed that this is better for the common use case of browsing for a certain method. Pick-to: 6.10 6.9 6.8 Task-number: PYSIDE-1106 Change-Id: I152be16f2a5ee5ea8c2869396a207b554738b219 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: adapt example card hover colorCristián Maureira-Fredes2024-12-101-1/+5
| | | | | | | | Using a colorscheme for light mode. Pick-to: 6.8 Change-Id: I323517140e4cd637883dca7b7597b477085591d5 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Finance Mananger - Part 1 - DocumentationShyamnath Premnadh2024-11-131-1/+9
| | | | | | | | | | | | - Detailed tutorial with instructions, explanaton of code concepts, gifs, steps to run and deploy the application. - Additionally, register a new role {deco} to be used in markdown. It is the same as :deco: in reStructuredText. Pick-to: 6.8 Task-number: PYSIDE-2850 Change-Id: Icb732e830948ee7ad1cb9dcf6bd07b5077c89497 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Docs: Fix sphinx warningsShyamnath Premnadh2024-08-161-1/+1
| | | | | | | - Mostly toctree warnings, missing file paths and indentation issues. Change-Id: I3531f3b7ab3341dd21955ffe73664916b81ecfa2 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: Find broken_linksShyamnath Premnadh2024-08-141-0/+7
| | | | | | | | | | | | | - Adds a new script that find the broken sphinx links and writes them into broken_links.json file. This is to be run after running sphinx-build with linkcheck, which will generate a output.json file with the status of all the links in the documentation. - Modified conf.py.in to ignore relative paths when runnning sphinx-build with linkcheck. Task-number: PYSIDE-2837 Change-Id: If2437049abc344ad942814a2304c88c4ef7b0c3f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Docs: Add html redirectsShyamnath Premnadh2024-08-141-1/+12
| | | | | | | | | | | | | - Since some .rst folders were renamed and reaaranged, this broke some existing links i.e. quickstart.html does not exist anymore since it was renamed to gettingstarted.html - This patch establishes redirects so that the old changed html links still exists and redirect to the new links. For this a new dependency of sphinx_reredirects is added. Task-number: PYSIDE-2837 Change-Id: I7af4a1ffef174b06fd8cb439ad1ccf52754c744d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Add support for decoratorsFriedemann Kleint2024-03-011-1/+2
| | | | | | | | | | | | | | | Add the necessary sphinx modules and configuration. In the doc generator, split out a helper to read an extra documentation page and scan for sphinx directives. Add a decorator list and write it below classes. As a drive-by, outdent the QML decorator descriptions. Task-number: PYSIDE-1106 Task-number: PYSIDE-2215 Change-Id: I813255385af60ab313b10be26fa20c56c768b405 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* doc: Update copyright year to 2024Adrian Herrmann2024-01-261-1/+1
| | | | | | | | | The copyright year on the documentation footer hasn't been updated since 2021. Pick-to: 6.6 Task-number: PYSIDE-1112 Change-Id: I8a8c1c07e77a9396479d08913f8e4b9133751bd6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: use modified version of the sphinx themeCristián Maureira-Fredes2024-01-181-0/+5
| | | | | | | | | | This modifies our requirements in order to use a forked version, including the option 'collapse_navbar' for the theme in order to avoid long build times. Change-Id: Id0f144d19927f481f254397babb95693c131bdc3 Pick-to: 6.6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Examples: Add Android tagShyamnath Premnadh2024-01-121-1/+8
| | | | | | | | | | | | | | | - Examples that work on Android are tagged Android. - Clicking the tag lists all PySide6 examples supported in Android. - sphinx-tags package added to add blog like tags to examples. [ChangeLog][PySide6] Examples supported on Android are tagged `Android` in documentation Pick-to: 6.6 Task-number: PYSIDE-1612 Change-Id: Ic4ea2c63756d060aeea85b0088da9ae248eda24e Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Documentation: Add a favicon for browser tabsFriedemann Kleint2024-01-081-1/+1
| | | | | | | | Pick-to: 6.6 Fixes: PYSIDE-2574 Change-Id: Ifa583c9a8ce13f1bdafe4621cb8d1cf5f8d35f79 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* docs: deprecate 'build_rst_docs' in favor of 'build_base_docs'Dennis Oberst2023-10-261-1/+1
| | | | | | | | | | | | | | | | | | | The command for building documentation files has been renamed to 'build_base_docs' and the previous command, 'build_rst_docs', has been deprecated. All relevant occurrences of the command have been updated accordingly. In addition, the documentation config and build directory 'build/pyside6/doc/rst' has been renamed to 'build/pyside6/doc/base'. To ensure a fresh start when generating new documentation, the auto-generated `examples` and `html` directories are now deleted before generating new documentation. This change has been made because these directories are generated anyway, and starting fresh ensures that there are no conflicts or issues with the new documentation. Task-number: PYSIDE-2504 Change-Id: I395ad7e9482b0b68311820d58da362513ebb44b2 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: use new logo and colorsCristián Maureira-Fredes2023-03-251-6/+6
| | | | | | | | | | | | | | | | | 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-171-6/+1
| | | | | | | | | | | | | | | | | | | | 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>
* 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 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: 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: Drop the HTML in the copyright textVenugopal Shivashankar2022-04-121-1/+1
| | | | | | Pick-to: 6.3 Change-Id: Id0be106e50bb0f33ac38a07db71ee7cfc4946efe Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: change color inactive example tabCristián Maureira-Fredes2022-04-111-0/+5
| | | | | Change-Id: I28fcfa2c832e8ff811a28a1654a91d5d4e636c7f Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Enable sphinx_copybutton extension for PySide tooVenugopal Shivashankar2022-04-081-3/+1
| | | | | | | | In addition, do not disable the copy_empty_lines config in the Shiboken project. Change-Id: I453c3df05d820052bc187d28a60d4e870b2c62f4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: new theme to follow the new Qt Doc styleCristián Maureira-Fredes2022-04-081-5/+23
| | | | | | | | | | | | | - Use 'furo' sphinx theme which offers a look-and-feel similar to the new Qt Documentation theme. - Change a few colors and styles to keep some details of the previous look-and-feel. - Add sphinx-copybutton extension to enable the copy-button feature against the snippet blocks. - Remove the 'pysidedocs' theme. Change-Id: I2be7186c5b043b4c75c65783abc2eab4056c493e 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: Enable URLs in inheritance diagramFriedemann Kleint2021-12-071-0/+2
| | | | | | | | | | | | | Switch graphviz generation to use SVG and add some functions to derive URLs from the attributes. This currently works only within one module; links to classes from other modules lack the required refuri node attribute. Task-number: PYSIDE-1725 Pick-to: 6.2 Change-Id: If93e78a6ba60168992b1acc0b926b5cfb57eeb7d Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* tutorials: update datavisualization and expensesCristián Maureira-Fredes2021-09-221-2/+0
| | | | | | | | | | | | | | | These tutorials were removed due to QtCharts not being available, additionally due to the QtCharts namespace changes the code needed to be adjusted. Adding panels for the tutorials to display as cards instead of a list, and creating a new section called 'General Applications'. Task-number: PYSIDE-841 Change-Id: I18fbce3fd48ed35013bcc82013ffc6e06f005b03 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: add sphinx-panels to the documentationCristian Maureira-Fredes2021-03-171-4/+5
| | | | | | | | | | | | | | | | | | | | | | 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>
* doc: example gallery show code in tabsCristian Maureira-Fredes2021-02-181-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 Pick-to: 6.0 Change-Id: Ibd66a8c911f05be13ae2700be6d3e95a2b98b775 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Switch from os.path to pathlib.Path, all source changes but testsChristian Tismer2021-02-101-2/+4
| | | | | | | | | | | With this patch, os.path in Shiboken and Pyside will be completely removed from sources. The rest will be done later. Task-number: PYSIDE-1499 Change-Id: Id01782779487ceec62efdd1f32f65beee0234338 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Fix link to FDL licenseTopi Reinio2021-01-271-1/+1
| | | | | | | And update the copyright year as well. Change-Id: If89a681f8c35027040ac6448f0aef760079bdb78 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* doc: Update references to Qt6Cristian Maureira-Fredes2020-12-091-1/+5
| | | | | | | | | | | * 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/+190
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-11-29 07:10:10 +0000