Repository navigation
Add pre-commit to docs conda environment - #469
Merged
Merged
Conversation
ax3l
reviewed
Sep 18, 2026
|
|
||
| dependencies: | ||
| - myst-parser | ||
| - pre-commit |
Member
There was a problem hiding this comment.
This is installed on RTD, so technically not needed there... But if we advertise this as the dev environment for docs then fine.
ax3l
approved these changes
Sep 18, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I think we need to add
pre-committo the conda environment used to develop and build the documentation locally. Otherwise,git commitresults in the following error, due to the presence of the.pre-commit-config.yamlfile in the root directory:We could also leave the conda environment file as is and rely on individual developers adding pre-commit locally, but this would have to happen every time a new dependency is added to the conda environment file and the conda environment needs to be recreated, so I don't find it very practical. I ran into exactly this problem when I tried pushing commits to #468 where the conda environment needed to be recreated (hence losing the previous one, where I had added pre-commit locally while working on #341).