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

Build developer docs in strict mode #8152

Merged
merged 1 commit into from
Dec 8, 2020
Merged

Conversation

florimondmanca
Copy link
Contributor

@florimondmanca florimondmanca commented Dec 7, 2020

What does this PR do?

Enable --strict mode when building docs.

Motivation

In this mode, mkdocs build errors out if any warnings were discovered while building:

Determines how warnings are handled. Set to true to halt processing when a warning is raised. Set to false to print a warning and continue processing.

https://www.mkdocs.org/user-guide/configuration/#strict

Prevents issues like #8150 from happening again. (We don't typically watch build logs to see if there are warnings, so they could sneak in unknowingly.)

Additional Notes

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have changelog/ and integration/ labels attached

@florimondmanca florimondmanca merged commit f651f9f into master Dec 8, 2020
@florimondmanca florimondmanca deleted the fm/mkdocs-strict branch December 8, 2020 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants