[Development] Documentation test builds in CI

[Kai Köhne]

Hi Topi,

Great news! This should save us quite some time hunting down qdoc errors 😊

Kai

From: Development <development-bounces at qt-project.org> On Behalf Of Topi Reiniö
Sent: Thursday, October 21, 2021 9:41 PM
To: development at qt-project.org
Subject: [Development] Documentation test builds in CI

Hello!
The testing cycle in Qt's CI now includes a documentation build step for submodules of the qt5 repository, in dev branch. What this means is that integrations may fail if they introduce new documentation warnings as reported by QDoc, and you are greeted with a "Documentation check failed" message in gerrit.

To resolve the reported issues, check the documentation on QDoc warnings at https://doc.qt.io/qt/qdoc-warnings.html - If you can't figure it out, add someone from the documentation team as a reviewer (always a good move when touching docs) and we'll do our best to help.

To temporarily disable the doc checks for a module that's under active development with a high commit inflow, remove the step from <repo_root>/coin/module_config.yaml.

Notes:

  * Testing for broken links is omitted as dependencies to other Qt's documentation modules are not available for the test build. These linking issues are detected as part of our daily snapshot builds and handled separately.

  * qt/qtbase and qt/qttools already have this step enabled. We're enabling it for the rest of the modules as we clear them of existing warnings. This may take a bit of time as we also need to update the qtbase dependency for some of the less-frequently trafficked repos.

Cheers,

Topi Reiniö | Principal Documentation Engineer | The Qt Company
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.qt-project.org/pipermail/development/attachments/20211022/4e02564a/attachment.html>