Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: make Sphinx warnings CI errors #6135

Closed
SyntaxColoring opened this issue Jul 15, 2020 · 3 comments
Closed

feat: make Sphinx warnings CI errors #6135

SyntaxColoring opened this issue Jul 15, 2020 · 3 comments
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).

Comments

@SyntaxColoring
Copy link
Contributor

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

  • Sphinx warnings cause CI builds to fail, preventing offending PRs from being merged.
@SyntaxColoring SyntaxColoring added 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. labels Jul 15, 2020
@mcous mcous added the robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). label Jan 26, 2021
@SyntaxColoring SyntaxColoring added the Robot Tech Debt For review in robot guild meetings label Sep 30, 2021
@SyntaxColoring
Copy link
Contributor Author

#9016 re-enabled non-fatal warnings because of surprising/spurious/uncontrollable failures in CI. We think they were because CI Python env changes made some internal Sphinx thing or plugin raise warnings, and Sphinx couldn't differentiate them from legitimate problems in our doc sources. We should revisit after updating Sphinx—we're currently on v2.2.0 and the latest is v4.

@ecormany
Copy link
Contributor

we've updated to Sphinx 5.0.1 (#10583) but still getting tons of warning text in the logs, e.g. https://github.com/Opentrons/opentrons/runs/7325998045

@SyntaxColoring
Copy link
Contributor Author

Replaced with Jira ticket RTC-198.

@SyntaxColoring SyntaxColoring closed this as not planned Won't fix, can't repro, duplicate, stale Oct 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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).
Projects
None yet
Development

No branches or pull requests

3 participants