Re: [Development] Documentation test builds in CI
> How do qtbase module integrations have their docs tested if qdoc is not built > at that point? > I'm guessing there's a pre-provisioned qdoc for each host platform? Correct. Both qdoc and qtattributionsscanner are provisioned. However, this step is run on a single platform only, Ubuntu 20.04 which has the 'TestDocs' feature. -Topi From: Alexandru Croitor Sent: Friday, October 22, 2021 1:02 PM To: Topi Reiniö Cc: development@qt-project.org Subject: Re: [Development] Documentation test builds in CI Hi, > On 21. Oct 2021, at 21:40, Topi Reiniö wrote: > > 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. Cool. > * 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. How do qtbase module integrations have their docs tested if qdoc is not built at that point? I'm guessing there's a pre-provisioned qdoc for each host platform? ___ Development mailing list Development@qt-project.org https://lists.qt-project.org/listinfo/development
Re: [Development] Documentation test builds in CI
Hi, > On 21. Oct 2021, at 21:40, Topi Reiniö wrote: > > 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. Cool. > * 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. How do qtbase module integrations have their docs tested if qdoc is not built at that point? I'm guessing there's a pre-provisioned qdoc for each host platform? ___ Development mailing list Development@qt-project.org https://lists.qt-project.org/listinfo/development
Re: [Development] Documentation test builds in CI
Hi Topi, Great news! This should save us quite some time hunting down qdoc errors Kai From: Development On Behalf Of Topi Reiniö Sent: Thursday, October 21, 2021 9:41 PM To: development@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 /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 ___ Development mailing list Development@qt-project.org https://lists.qt-project.org/listinfo/development
[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 /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 ___ Development mailing list Development@qt-project.org https://lists.qt-project.org/listinfo/development
