-
Epic
-
Resolution: Fixed
-
P1: Critical
-
None
-
None
-
Docs in CI
-
Da Vinci sprint 10, Da Vinci sprint 11, Da Vinci sprint 26, Da Vinci sprint 27, Da Vinci sprint 28, Da Vinci sprint 29, Da Vinci sprint 30, Da Vinci sprint 31, Da Vinci sprint 32, Da Vinci sprint 33, Da Vinci sprint 38, Da Vinci sprint 39, Da Vinci sprint 40, Da Vinci sprint 41, Da Vinci sprint 42
As a developers of the Qt project we would like to keep documentation of our source code up-to date and consistent by making documentation checks part of our CI pipeline.
Acceptance Criteria(s)
- Doc checks to become mandatory in CI
- CI build should fail during integration, if the patch introduces extra qdoc warnings
- Have ability to run same Qdoc-sanity check manually from Gerrit. It's should be optional
Additional Points:
- Nice to have a pre-push hook that reveals un-documented code changes in the patch without actually running qdoc.
- replaces
-
QTBUG-74778 Doc: Block changes in CI that introduce QDoc warnings
-
- Closed
-
| For Gerrit Dashboard: QTBUG-78069 | ||||||
|---|---|---|---|---|---|---|
| # | Subject | Branch | Project | Status | CR | V |
| 304350,2 | qdoc: Respect --nolinkerrors when generating warnings | dev | qt/qttools | Status: MERGED | +2 | 0 |
| 304695,8 | CI: Run QDoc as part of testing cycle | dev | qt/qttools | Status: MERGED | +2 | 0 |
| 304698,2 | CMake: Add a platform specific to documentation checks in CI | dev | qt/qt5 | Status: ABANDONED | 0 | 0 |
| 304822,2 | Doc: Enforce zero documentation warning policy | dev | qt/qttools | Status: MERGED | +2 | 0 |
| 331625,15 | coin: Add instructions to generate docs during testing | dev | qt/qtbase | Status: MERGED | +2 | 0 |
| 377210,2 | coin: Add instructions to generate docs during testing | 6.2 | qt/qtbase | Status: MERGED | +2 | 0 |