build: add Documentation linting step to CI #35794
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
#32741 removed the documentation build step because it was taking > 40 minutes to run.
This PR adds a "documentation lint" step to the CI which uses sphinx-lint. This doesn't build the whole documentation tree, but should let PR creators know if they've made any code changes that break documentation.
This change affects Developers only.
Supporting information
See #35766 (comment) for more context.
Testing instructions
To verify that this added step helps us:
make docs-lintshould fail with the error reported in the referenced PR.Deadline
None