Fix sphinx warnings in `mach doc` and make them fail the build

ASSIGNED
Assigned to

Status

enhancement
ASSIGNED
4 months ago
Yesterday

People

(Reporter: ahal, Assigned: championshuttler)

Tracking

(Blocks 1 bug, {leave-open})

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(5 attachments)

If you run mach doc there are tons of WARNINGS that are spewed to stdout. We should fix them all and configure sphinx-build to fail on warnings to prevent new ones from being added in the future. This is likely a large task, so we may want to turn this into a meta bug and file dependents to start fixing this little by little.

This is also closely related to bug 1527361, as that will catch and prevent many of the same issues. I think doing both of these things are still worthwhile however.

Summary: Fix sphinx warnings in `mach doc` → Fix sphinx warnings in `mach doc` and make them fail the build

Great, thanks Shivam!

I'm setting leave-open which means the bug will remain open after patches land. This way if you wish to keep working on this issue, you can submit multiple patches on top of one another until you either want to stop or all of the warnings have been fixed. Please let me know if you want to continue working on this or not.

Assignee: nobody → shivams2799
Status: NEW → ASSIGNED
Keywords: leave-open
Pushed by ahalberstadt@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/5d251a7e6031
Fix Sphinx Warning - Title Underline too short  in 'mach doc'. r=ahal
https://hg.mozilla.org/projects/ash/rev/5d251a7e6031cd707c83c9b22425610d3e056f1d
Bug 1536103 - Fix Sphinx Warning - Title Underline too short  in 'mach doc'. r=ahal
Attachment #9072775 - Attachment description: Bug 1536103 - Fix sphinSphinx Warning - Unexpected indentation (1). r=ahal → Bug 1536103 - Fix Sphinx Warning - Unexpected indentation (1). r=ahal
Attachment #9072775 - Attachment description: Bug 1536103 - Fix Sphinx Warning - Unexpected indentation (1). r=ahal → Bug 1536103 - Fix sphinSphinx Warning - Unexpected indentation (1). r=ahal
Attachment #9072775 - Attachment description: Bug 1536103 - Fix sphinSphinx Warning - Unexpected indentation (1). r=ahal → Bug 1536103 - Fix Sphinx Warning - Unexpected indentation (1). r=ahal
Attachment #9072775 - Attachment description: Bug 1536103 - Fix Sphinx Warning - Unexpected indentation (1). r=ahal → Bug 1536103 - Fix sphinSphinx Warning - Unexpected indentation (1). r=ahal
Attachment #9072775 - Attachment description: Bug 1536103 - Fix sphinSphinx Warning - Unexpected indentation (1). r=ahal → Bug 1536103 - Fix Sphinx Warning - Unexpected indentation (1). r=ahal
Pushed by ahalberstadt@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/97b7600d3c92
Fix Sphinx Warning - Unexpected indentation (1). r=ahal
https://hg.mozilla.org/integration/autoland/rev/61c481e2d2e8
Fix Sphinx Warning - Title Underline too short in 'mach doc' (2). r=ahal
https://hg.mozilla.org/integration/autoland/rev/8a205b411e7e
Fix various Sphinx Warning in 'mach doc' (3). r=ahal
Pushed by ahalberstadt@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/61ef4dac17e1
Fix various Sphinx Warning in 'mach doc' (4). r=ahal
You need to log in before you can comment on or make changes to this bug.