feat: make Sphinx warnings CI errors #6135
Labels
api
Affects the `api` project
docs
feature-request
A request for a new feature or a change that isn't a bug. May require further triage or scoping.
Robot Tech Debt
For review in robot guild meetings
robot-svcs
Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience).
Overview
This ticket takes over for PR #5794, which was a first step at a solution to this problem.
make docs
prints a lot of Sphinx warnings, which makes it hard to work on the API docs. (Legitimate mistakes are easy to lose in the noise.)After fixing those warnings, new warnings should be turned into CI errors, so they're caught early and won't accumulate again.
Implementation details
Design
Acceptance criteria
The text was updated successfully, but these errors were encountered: