8000 Add sphinx-lint as a pre-commit hook by AlexWaygood · Pull Request #627 · python/typing_extensions · GitHub
[go: up one dir, main page]
Skip to content

Add sphinx-lint as a pre-commit hook #627

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 7, 2025
Merged

Add sphinx-lint as a pre-commit hook #627

merged 1 commit into from
Jul 7, 2025

Conversation

AlexWaygood
Copy link
Member

The tool checks for correctness issues in .rst files, and our documentation uses reStructured text. It doesn't currently find any issues in our docs.

srittau
srittau approved these changes Jul 7, 2025
View reviewed changes
Copy link
Collaborator
@srittau srittau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also noticed that currently we don't build the docs as part of the CI process. We should probably do that as well to spot any potential problems.

@AlexWaygood
Copy link
Member Author

I also noticed that currently we don't build the docs as part of the CI process. We should probably do that as well to spot any potential problems.

and docs previews as well would be wonderful!

@AlexWaygood AlexWaygood merged commit a50c112 into main Jul 7, 2025
21 checks passed
@AlexWaygood AlexWaygood deleted the sphinx-lint branch July 7, 2025 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@srittau srittau srittau approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AlexWaygood @srittau
0