Details
-
Type:
User Story
-
Status: Open
-
Priority:
P2: Important
-
Resolution: Unresolved
-
Affects Version/s: 5.9, 5.11.0, dev
-
Fix Version/s: None
-
Component/s: Documentation
-
Labels:None
Description
The generated documentation include code from Qt.
Some of this code has been translated to Python, and it is currently placed in:
sources/pyside2/doc/codesnippets/doc/src/snippets/
Still, there are a few things to be addressed:
- Verify if all the Python code portions works
- Translate all the C++ references to Python
- Exclude the elements that we are not using, e.g.: QList<String> exists only as a Python string list, but we currently have documentation about it.
Additionally, some functions needs extra explanation, like QObject.findChild/find.Children and return types that are described as a python type that is not clear, e.g.: PyTuple.
Attachments
Issue Links
- is required for
-
PYSIDE-363 Fix documentation generation
-
- Closed
-
Gerrit Reviews
For Gerrit Dashboard: PYSIDE-691 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
273052,8 | WIP: Corrects the snippets for the docs for PySide multimedia | 5.13.2 | pyside/pyside-setup | Status: NEW | -2 | 0 |
274130,3 | Docs: separate snippets into standalone files | 5.14 | qt/qtbase | Status: NEW | -1 | 0 |
328648,15 | Long live snippets_translate! | dev | pyside/pyside-setup | Status: NEW | +1 | 0 |
231913,4 | Adapt snippets/code to python | 5.12 | pyside/pyside-setup | Status: ABANDONED | 0 | 0 |
231916,1 | WIP: Adapt snippets/widget-tutorial to python | 5.14 | pyside/pyside-setup | Status: ABANDONED | -2 | 0 |
237680,6 | Add explanation to findChild/findChildren methods | 5.11 | pyside/pyside-setup | Status: MERGED | +2 | 0 |
238212,2 | Doc: Change the snippet file extensions | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
238669,14 | Doc: Move literal code block to a separate file | 5.12 | qt/qtbase | Status: MERGED | -2 | 0 |
243179,2 | Update documentation | 5.12 | pyside/pyside-setup | Status: MERGED | +2 | 0 |
248575,4 | Doc: Update and fix the Slot documentation | 5.12 | pyside/pyside-setup | Status: MERGED | +2 | 0 |
256774,8 | Doc: Add descriptions, pages, and moving modules | 5.12 | pyside/pyside-setup | Status: MERGED | +2 | 0 |
301600,4 | Rename and update some snippets | 5.15 | pyside/pyside-setup | Status: MERGED | +2 | 0 |
308525,3 | doc: add qmlRegisterType and qmlRegisterSingletonType | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |