Replace doc8 with sphinx-lint #16431
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
miketheman
added
documentation
developer experience
Signed-off-by: Mike Fiedler <[email protected]>
Restrict docs to dev-only, as the others are markdown and don't need to be checked. Signed-off-by: Mike Fiedler <[email protected]>
Signed-off-by: Mike Fiedler <[email protected]>
miketheman
force-pushed
the
miketheman/doc8-to-sphinx-lint
branch
from
811145e to
14710d4
Compare
Signed-off-by: Mike Fiedler <[email protected]>
ewdurbin
approved these changes
Aug 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
doc8 didn't catch things that make Sphinx unhappy, so use https://pypi.org/project/sphinx-lint/ instead, like cpython does (they trigger it via pre-commit).
This also should unblock upgrades to
readme-renderer, as this checker does not rely ondocutilsat all.