Docs: move sphinx-lint to pre-commit#105750
Uh oh!
There was an error while loading. Please reload this page.
Conversation
AlexWaygood left a comment
AlexWaygood left a comment There was a problem hiding this comment.
I'm not a great reviewer for the change to the Makefile, but everything else LGTM (and I approve of the idea)!
hugovk commented Jun 13, 2023
Thanks! I should also mention I based the Makefile stuff from the peps repo: https://github.com/python/peps/blob/1b0666eafa3d6ca2c5804f7ed41e49ebb74ca831/Makefile#L62-L66 (Which may have come from similar things in https://github.com/python-pillow/Pillow/blob/main/Makefile) |
| $(SPHINXLINT) -i tools -i $(VENVDIR) --enable default-role | ||
| $(SPHINXLINT) --enable default-role ../Misc/NEWS.d/next/ | ||
| check: venv | ||
| $(VENVDIR)/bin/python3 -m pre_commit --version > /dev/null ||$(VENVDIR)/bin/python3 -m pip install pre-commit |
There was a problem hiding this comment.
Any reason why this is installed like this instead of adding it to requirements.txt?
Everything else LGTM.
There was a problem hiding this comment.
Good question, I think to prefer running pre-commit when committing to Git, and avoid installing it unless we really need to - usually we don't need it installed with all the other venv things.
CAM-Gerlach commented Jun 16, 2023
Since we also moved the 3.12 branch to using pre-commit and this is just a background infra change, I marked this for backport there too. |
miss-islington commented Jun 18, 2023
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12. |
(cherry picked from commit bc07c8f) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
bedevere-bot commented Jun 18, 2023
GH-105894 is a backport of this pull request to the 3.12 branch. |
bedevere-bot commented Aug 22, 2023
GH-108276 is a backport of this pull request to the 3.11 branch. |
6 participants
Move sphinx-lint to pre-commit, and so out of the Docs' various requirements.txt files.
Change
make -C Doc checkto run pre-commit instead of only sphinx-lint.pre-commit is run on the CI in lint.yml, so we no longer need to run
make checkthere.📚 Documentation preview 📚: https://cpython-previews--105750.org.readthedocs.build/