diff options
| author | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2024-08-07 11:51:20 +0200 |
|---|---|---|
| committer | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2024-08-14 13:52:47 +0200 |
| commit | e3c2d8d1cf21403186625c1e62d2219a650eccef (patch) | |
| tree | ffcd230ae04339908c46e035c3241013290ea537 /sources/pyside6/doc/gettingstarted.rst | |
| parent | a12fbe8cfde50e93052ee1dbc1ac959d81f2a184 (diff) | |
Doc: Update Shiboken module documentation
- The function list used cross references, but this was never working.
The warning showed up when sphinx-build was run with the '-n' option.
Cross referencing to the function description is now setup with this
patch i.e. the function names are now clickable from the top of the
page
- Use :py:function instead of :function for Shiboken module functions.
These functions are now formatted/highlighted according to Python
conventions.
- Add parameter types and return types to all the functions.
- Two functions - ownedByPython and wasCreatedByPython - were named
incorrectly. These are now corrected.
- Some functions and a class was missing from the top of the page.
They are correctly added now.
- use '.. py:module' sphinx directive for the Shiboken module.
Task-number: PYSIDE-2837
Change-Id: I8da08ee210fb7ebee003cd3262c0a0432da44cc6
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside6/doc/gettingstarted.rst')
0 files changed, 0 insertions, 0 deletions