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

Add support for "warnings as errors" #363

Closed
Lukasa opened this issue Aug 17, 2022 · 0 comments · Fixed by #365
Closed

Add support for "warnings as errors" #363

Lukasa opened this issue Aug 17, 2022 · 0 comments · Fixed by #365

Comments

@Lukasa
Copy link

Lukasa commented Aug 17, 2022

Feature Name

Warnings as errors

Description

Adopters can pass a flag that will promote warnings when building the documentation into errors that fail the doc build.

Motivation

Lots of projects want to build their documentation in CI. In these cases it's possible to introduce docs warnings that provide useful signal, such as notifying us that there is a broken reference in the docs. Catching this in CI allows us to produce the best documentation possible.

Importance

This is fairly important: while it can be retroactively handled by processing the textual output from the build, this is brittle and adds a tricky dependency on the text output format.

Alternatives Considered

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant