Skip to content

Commit

Permalink
build: use --check-only with build-docs hook (turns off automatic reb…
Browse files Browse the repository at this point in the history
…uilding)
  • Loading branch information
Jeremy Silver committed May 3, 2024
1 parent f128d27 commit dd3925b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
5 changes: 3 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,11 @@ repos:
- id: commitizen
stages: [commit-msg]
- repo: https://github.com/jeremander/gadzooks
rev: v0.2.6
rev: v0.2.7
hooks:
- id: build-docs
args: ['--src-docs', 'docs', '--', 'mkdocs', 'build', '--strict', '--no-directory-urls', '-d', 'fancy_dataclass/docs']
# args: ['--src-docs', 'docs', '--', 'mkdocs', 'build', '--strict', '--no-directory-urls', '-d', 'fancy_dataclass/docs']
args: ['--src-docs', 'docs', '--check-only']
pass_filenames: false
verbose: true
- id: loc-summarize
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ dependencies = [
build = "mkdocs build --clean --strict --no-directory-urls {args}"
# build docs within the package, if not already up-to-date
build-pkg = "gadzooks build-docs --src-docs docs {args} -- mkdocs build --strict --no-directory-urls -d fancy_dataclass/docs"
check = "gadzooks build-docs --src-docs docs --check-only {args}"
serve = "mkdocs serve"
deploy = "mkdocs build --site-dir $READTHEDOCS_OUTPUT/html"

Expand Down

0 comments on commit dd3925b

Please sign in to comment.