Updating pre-commit command for sphinx builds. #179
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
drewoldag
added
bug
drewoldag
requested review from
a team and
cchris28
and removed request for
a team
cchris28
approved these changes
Apr 18, 2023
| "./docs/build/doctrees", # Directory | ||
| "./docs/_build/doctrees", # Directory | ||
| "-D", # Flag to override settings in conf.py | ||
| "exclude_patterns=notebooks/*", # Exclude our notebooks from pre-commit |
Collaborator
There was a problem hiding this comment.
this remains a difference. The pre-commit excludes notebooks while the sphinx builds include the notebooks.
I am only noting this since we really do not want the precommit to buid notebooks (dependency on pandocs).
Collaborator
Author
There was a problem hiding this comment.
Correct, and good observation. Additionally, building notebooks could take a long time if there is a significant amount of processing. It was a conscious decision to not build notebooks during the pre-commit step for these very reasons.
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.
The pre-commit hook and the Make file for building documentation were pushing output files to different locations. Specifically, the pre-commit hook was sending output files to
./docs/build/...while the make file was using./docs/_buildand./_readthedocs.The changes in this PR will bring the pre-commit hooks (w/ and w/o notebook rendering) into alignment with the sphinx Make file.
I've tested this locally by repeatedly running the following commands:
make htmland
pre-commit run --all-files sphinx-buildover two different hydrated projects.
The first was created with notebook rendering enabled, and the second was created without notebook rendering.