1915550 - Make ERRORs raised in 'mach doc generate' be failures

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Documentation, task)

Description

[Mark Banner (:standard8)]

Currently, we are only looking for warnings when running ./mach doc. This means we're missing raising various errors about issues with the generation, a lot of these are unknown targets or other unexpected/incorrect items.

We should start causing the generate task to fail when these occur so that we can make sure they get resolved. We'll need an allow list for the existing errors that we can hopefully reduce down over time.

Comment 1

[Mark Banner (:standard8)]

Attachment: Bug 1915550 - Make ERRORS raised during 'mach doc generate' be failures. r?sylvestre!

Comment 2

[Mark Banner (:standard8)]

Attachment: Bug 1915550 - Fix document errors in urlbar dynamic-result-types. r?#urlbar-reviewers!

The error was:
ERROR: Unknown target name: "appendix b: using the webextensions api directly".

This is out of date documentation as we no longer support webextensions for dynamic result types.

Comment 3

[Mark Banner (:standard8)]

Attachment: Bug 1915550 - Fix 'Document may not end with a transition' errors in Android documentation. r?#android-reviewers!

Comment 4

[Mark Banner (:standard8)]

Attachment: Bug 1915550 - Fix unknown target name issues in rst documents. r?sylvestre!

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/19f452367a1d
Fix document errors in urlbar dynamic-result-types. r=urlbar-reviewers,jteow
https://hg.mozilla.org/integration/autoland/rev/8991e07d3c46
Fix 'Document may not end with a transition' errors in Android documentation. r=android-reviewers,skhan
https://hg.mozilla.org/integration/autoland/rev/8d079a3f7a4a
Fix unknown target name issues in rst documents. r=sylvestre,profiler-reviewers,canaltinova
https://hg.mozilla.org/integration/autoland/rev/18e95c19efd8
Make ERRORS raised during 'mach doc generate' be failures. r=sylvestre

Comment 6

[tszentpeteri]

https://hg.mozilla.org/mozilla-central/rev/19f452367a1d
https://hg.mozilla.org/mozilla-central/rev/8991e07d3c46
https://hg.mozilla.org/mozilla-central/rev/8d079a3f7a4a
https://hg.mozilla.org/mozilla-central/rev/18e95c19efd8