aboutsummaryrefslogtreecommitdiffstats
path: root/tools/doc_modules.py
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: Exclude QtChartsFriedemann Kleint2025-02-281-3/+2
| | | | | | | | It causes duplicate entries in QtGraphs. Complements a9307dd0fe4d35d1d8a5b15c7d9361ac2cad8ac9. Change-Id: I9fadcdad789795dfc61a522fab9deaa1786f8d71 Reviewed-by: Shyamnath Premnadh <[email protected]>
* Python-3.10: Allow the new syntax for Python 3.9Christian Tismer2024-06-201-0/+1
| | | | | | | | Add a future statement to all Python source files. Task-number: PYSIDE-2786 Change-Id: Icd6688c7795a9e16fdcaa829686d57792df27690 Reviewed-by: Adrian Herrmann <[email protected]>
* Documentation: Indicate XML parse errors to be warnings in doc_modules.pyFriedemann Kleint2023-12-151-1/+1
| | | | | | | Task-number: PYSIDE-1106 Pick-to: 6.6 Change-Id: I449299a92c91431fe6b742021cee33ae745d0589 Reviewed-by: Adrian Herrmann <[email protected]>
* Documentation: Exclude QtDataVisualizationFriedemann Kleint2023-08-231-0/+3
| | | | | | | | QtGraphs duplicates symbols from QtDataVisualization causing shiboken errors. Exclude the now deprecated QtDataVisualization. Change-Id: Iacdde84189ee87cf4ea058aa635272e187c30fce Reviewed-by: Shyamnath Premnadh <[email protected]>
* Documentation: Fix modules being omitted from the documentationFriedemann Kleint2022-10-121-4/+90
| | | | | | | | | | | | | | | | | | | 327350779203bdde7728a87e513e7e27dfc8e876 introduced a script tools/doc_modules.py that outputs all modules in the correct dependency order to prevent dependent typesystems to be loaded with generate="no". The generated order unfortunately clashed with the special casing in sources/pyside6/doc/CMakeLists.txt for modules with qdocconf files containing several modules. To fix this, move writing of required files (global header, global type system and global qdocfong) to the script tools/doc_modules.py. Only the configure steps for the qdocconf files are done in CMake. Pick-to: 6.4 6.4.0 Task-number: PYSIDE-1106 Change-Id: Ibd6d03e6622a220236298ccd59f03c6612cc908c Reviewed-by: Adrian Herrmann <[email protected]> Reviewed-by: Cristian Maureira-Fredes <[email protected]>
* Generate documentation for all modules independentlyFriedemann Kleint2022-09-151-0/+120
Previously, only the modules that were built in PySide were considered for documentation, which required one to create a full build just to build the documentation. One reason for this was that the inheritance diagram creation determined the base classes by loading the classes/modules and do introspection. This has been replaced by a mechanism were shiboken creates a JSON inheritance file. It is then sufficient to have the modules built in Qt so that the includes exist for shiboken and qdoc finds the source. Add a script that retrieves the Qt modules built by looking at the Qt include path, rearranges them by dependency order and use that as an input to the documentation checks. With that, a minimal build of PySide6 suffices to generate the complete documentation. The script can be used standalone with an option to print warnings about modules not built in Qt. Task-number: PYSIDE-1106 Change-Id: Iade4c6f1d3d255f7052be94d0a6fd647f5ee4ed3 Reviewed-by: Qt CI Bot <[email protected]> Reviewed-by: Cristian Maureira-Fredes <[email protected]>