Skip to content

Updating pre-commit command for sphinx builds. #179

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

Merged
drewoldag merged 1 commit into from
Apr 18, 2023
Merged

Updating pre-commit command for sphinx builds. #179

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions python-project-template/.pre-commit-config.yaml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,11 +150,11 @@ repos:
# Note: -M requires next 3 args to be builder, source, output
"html", # Specify builder
"./docs", # Source directory of documents
"./docs/build/html", # Output directory for rendered documents
"./_readthedocs", # Output directory for rendered documents
"-T", # Show full trace back on exception
"-E", # Don't use saved env; always read all files
"-d", # Flag for cached environment and doctrees
"./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
Copy link
Collaborator

@cchris28 cchris28 Apr 18, 2023

Choose a reason for hiding this comment

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

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).

Copy link
Collaborator Author

@drewoldag drewoldag Apr 18, 2023

Choose a reason for hiding this comment

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

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.

]
Expand All @@ -175,8 +175,8 @@ repos:
"-b", # Flag to select which builder to use
"html", # Use the HTML builder
"-d", # Flag for cached environment and doctrees
"docs/build/doctrees", # directory
"./docs/_build/doctrees", # directory
"./docs", # Source directory of documents
"docs/build/html", # Output directory for rendered documents.
"./_readthedocs", # Output directory for rendered documents.
]
{%- endif %}