Details
-
User Story
-
Resolution: Fixed
-
P3: Somewhat important
-
None
-
None
-
None
-
All
-
44385439c (dev), f85114909 (dev), a12fbe8cf (dev), e3c2d8d1c (dev), 1d1274a57 (dev), 3f78f5f1a (dev), 915644419 (dev), d2318d7aa (dev), ffa9e4978 (dev)
Description
There are a lot of sections in the documentation that can be improved. This User Story resulted from many past discussions and https://bugreports.qt.io/browse/PYSIDE-2833
Some of the things targetted:
- Use sphinx references consistently across the documentation. Currently relative paths are used which can break documentation when file name or paths are changed.
- Add warning checks for missing references to easily identify cross reference errros.
- Fix expired or invalid links in the base documentation
More issues will be added and fixed as they are identified.
Attachments
Issue Links
- relates to
-
PYSIDE-2833 Qt Quick/QML + Python documentation is not easily discoverable and is lacking
-
- Reported
-
| For Gerrit Dashboard: PYSIDE-2837 | ||||||
|---|---|---|---|---|---|---|
| # | Subject | Branch | Project | Status | CR | V |
| 581053,9 | Documentation: Rearrange sections | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 581613,7 | Docs: Warnings for missing references | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 581614,10 | Doc: Update Shiboken module documentation | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 581982,5 | Docs: Use sphinx reference in gettingstarted.rst | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 581983,6 | Docs: Update examples documentation to use sphinx references | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 582092,7 | Docs: Add html redirects | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 582283,3 | Docs: Find broken_links | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 582284,5 | Docs: Update tutorial to use sphinx references | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 585861,2 | Documentation: Sphinx reference for markdown examples | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |