Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-78069

Make documentation part of CI pipeline

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: In Progress
    • Priority: P1: Critical
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 6.3
    • Labels:
      None
    • Epic Name:
      Docs in CI
    • Sprint:
      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

      Description

      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)

      1. Doc checks to become mandatory in CI
      2. CI build should fail during integration, if the patch introduces extra qdoc warnings
      3. 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.   

       

        Attachments

          Issue Links

          For Gerrit Dashboard: QTBUG-78069
          # Subject Branch Project Status CR V

            Activity

              People

              Assignee:
              docinfrastructure Documentation Infrastructure Team
              Reporter:
              levon.sargsyan Levon Sargsyan (Inactive)
              PM Owner:
              Tino Pyssysalo Tino Pyssysalo
              RnD Owner:
              Paul Wicking Paul Wicking
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:

                  Gerrit Reviews