diff --git a/CHANGELOG.md b/CHANGELOG.md index be739b0..ae1bf38 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,7 @@ ## Tools development version +- minor documentation improvements. (#197, #198, @kelly-sovacool) + ## Tools 0.7.0 - New pre-commit hook: `ccbr-hooks sync-nextflow-version`. Syncs `manifest.version` in `nextflow.config` from the repo `VERSION` file. (#193, @kelly-sovacool, @copilot) diff --git a/docs/.gitignore b/docs/.gitignore index b38a1f8..37cf5ad 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -6,3 +6,5 @@ /_freeze/ /site_libs/ /_inv/ + +**/*.quarto_ipynb diff --git a/docs/_quarto.yml b/docs/_quarto.yml index b9f381c..a0bc350 100644 --- a/docs/_quarto.yml +++ b/docs/_quarto.yml @@ -83,6 +83,7 @@ quartodoc: contents: - hooks - hooks.detect_absolute_paths + - hooks.sync_nextflow_version - title: Legacy tools contents: - GSEA.deg2gs diff --git a/docs/render_site.sh b/docs/render_site.sh index dbbfa96..0209fc0 100755 --- a/docs/render_site.sh +++ b/docs/render_site.sh @@ -1,4 +1,3 @@ ccbr_tools quarto-add fnl -python -m quartodoc build --verbose -python -m quartodoc interlinks +python -m quartodoc build --verbose && python -m quartodoc interlinks quarto render diff --git a/src/ccbr_tools/hooks/sync_nextflow_version.py b/src/ccbr_tools/hooks/sync_nextflow_version.py index 7cd2a93..0aef55d 100644 --- a/src/ccbr_tools/hooks/sync_nextflow_version.py +++ b/src/ccbr_tools/hooks/sync_nextflow_version.py @@ -1,6 +1,8 @@ """ Synchronize `manifest.version` in `nextflow.config` with the repo `VERSION` file. +Whenever the `VERSION` file is updated, the `manifest.version` entry in `nextflow.config` will be updated to match it. + ## Usage with pre-commit Add this to your `.pre-commit-config.yaml` file: