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 docs on how best to use sphinx-lint with pre-commit #90

Merged
merged 4 commits into from
Oct 13, 2023

Conversation

AlexWaygood
Copy link
Collaborator

Closes #76

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@AlexWaygood AlexWaygood merged commit 4cecfc7 into sphinx-contrib:main Oct 13, 2023
18 checks passed
@AlexWaygood AlexWaygood deleted the patch-1 branch October 13, 2023 15:10
@hugovk
Copy link
Collaborator

hugovk commented Oct 15, 2023

A thought: rather than requiring users set the flag in their pre-commit config, can we set it as a default in https://github.com/sphinx-contrib/sphinx-lint/blob/main/.pre-commit-hooks.yaml?

Docs: https://pre-commit.com/index.html#hooks-args

@AlexWaygood
Copy link
Collaborator Author

A thought: rather than requiring users set the flag in their pre-commit config, can we set it as a default in https://github.com/sphinx-contrib/sphinx-lint/blob/main/.pre-commit-hooks.yaml?

Docs: https://pre-commit.com/index.html#hooks-args

Oh, very good idea!

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 this pull request may close these issues.

Make sphinx-lint faster
3 participants