Skip to content

Commit de53383

Browse files
committed
Merge remote-tracking branch 'origin/main' into codex/lock-docs
2 parents eb744ce + d2ccfdf commit de53383

111 files changed

Lines changed: 2909 additions & 1668 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/main.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,13 @@ jobs:
2929
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
3030
with:
3131
persist-credentials: false
32-
- uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
32+
- uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
3333
with:
3434
enable-cache: true
3535
- name: Install just
3636
uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4.0.0
37+
with:
38+
just-version: "1.43.1"
3739
- name: Install graphviz
3840
run: |
3941
sudo apt-get update
@@ -57,12 +59,14 @@ jobs:
5759
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
5860
with:
5961
persist-credentials: false
60-
- uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
62+
- uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
6163
with:
6264
enable-cache: true
6365
python-version: ${{ matrix.python-version }}
6466
- name: Install just
6567
uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4.0.0
68+
with:
69+
just-version: "1.43.1"
6670

6771
- if: matrix.os == 'ubuntu-latest'
6872
run: |

.github/workflows/publish-to-pypi.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ jobs:
1616
with:
1717
persist-credentials: false
1818
- name: Install uv
19-
uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
19+
uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
2020
with:
2121
enable-cache: true
2222
python-version: "3.13"
2323
- name: Build a binary wheel and a source tarball
2424
run: uv build
2525
- name: Store the distribution packages
26-
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
26+
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
2727
with:
2828
name: python-package-distributions
2929
path: dist/
@@ -47,7 +47,7 @@ jobs:
4747
name: python-package-distributions
4848
path: dist/
4949
- name: Install uv
50-
uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
50+
uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
5151
- name: Publish distribution 📦 to PyPI
5252
run: uv publish
5353

.github/workflows/update-plugin-list.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ jobs:
2525
persist-credentials: false
2626

2727
- name: Install uv
28-
uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
28+
uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
2929
with:
3030
python-version: 3.12
3131

3232
- name: Update Plugin List
3333
run: uv run --group plugin-list python scripts/update_plugin_list.py
3434

3535
- name: Create Pull Request
36-
uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0
36+
uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1
3737
with:
3838
commit-message: '[automated] Update plugin list'
3939
author: 'Tobias Raabe <tobiasraabe@users.noreply.github.com>'

.github/workflows/zizmor.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
with:
2727
persist-credentials: false
2828

29-
- uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
29+
- uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
3030
with:
3131
enable-cache: true
3232
python-version: '3.13'
@@ -43,6 +43,6 @@ jobs:
4343
always() &&
4444
(github.event_name != 'pull_request' ||
4545
github.event.pull_request.head.repo.full_name == github.repository)
46-
uses: github/codeql-action/upload-sarif@c10b8064de6f491fea524254123dbe5e09572f13 # v4
46+
uses: github/codeql-action/upload-sarif@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4
4747
with:
4848
sarif_file: zizmor.sarif

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,4 @@ tests/test_jupyter/*.txt
3030
.venv
3131
docs/jupyter_execute
3232
.DS_Store
33+
docs/source/reference_guides/commands.md

.pre-commit-config.yaml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ repos:
88
- id: check-merge-conflict
99
- id: check-vcs-permalinks
1010
- id: check-yaml
11-
exclude: (^mkdocs\.yml$)
1211
- id: debug-statements
1312
exclude: (debugging\.py)
1413
- id: end-of-file-fixer
@@ -26,14 +25,21 @@ repos:
2625
- id: python-no-log-warn
2726
- id: text-unicode-replacement-char
2827
- repo: https://github.com/astral-sh/ruff-pre-commit
29-
rev: v0.15.10
28+
rev: v0.15.12
3029
hooks:
3130
- id: ruff-format
3231
- id: ruff-check
3332
- repo: https://github.com/astral-sh/uv-pre-commit
34-
rev: 0.11.6
33+
rev: 0.11.12
3534
hooks:
3635
- id: uv-lock
36+
- repo: local
37+
hooks:
38+
- id: check-termynal-line-lengths
39+
name: Check Termynal line lengths
40+
entry: python scripts/check_termynal_line_lengths.py
41+
language: python
42+
files: ^docs/source/_static/md/.*\.md$
3743
- repo: https://github.com/executablebooks/mdformat
3844
rev: 1.0.0
3945
hooks:
@@ -54,14 +60,14 @@ repos:
5460
mdformat-pyproject>=0.0.2,
5561
]
5662
files: (docs/.)
57-
exclude: (docs/source/reference_guides/hookspecs\.md|docs/source/api/.*\.md|docs/source/how_to_guides/capture_warnings\.md|docs/source/how_to_guides/hashing_inputs_of_tasks\.md|docs/source/how_to_guides/provisional_nodes_and_task_generators\.md|docs/source/how_to_guides/remote_files\.md|docs/source/how_to_guides/writing_custom_nodes\.md|docs/source/tutorials/defining_dependencies_products\.md|docs/source/tutorials/using_a_data_catalog\.md)
63+
exclude: (docs/source/reference_guides/hookspecs\.md|docs/source/reference_guides/api/.*\.md|docs/source/how_to_guides/capture_warnings\.md|docs/source/how_to_guides/hashing_inputs_of_tasks\.md|docs/source/how_to_guides/provisional_nodes_and_task_generators\.md|docs/source/how_to_guides/remote_files\.md|docs/source/how_to_guides/writing_custom_nodes\.md|docs/source/tutorials/defining_dependencies_products\.md|docs/source/tutorials/using_a_data_catalog\.md)
5864
- repo: https://github.com/kynan/nbstripout
5965
rev: 0.9.1
6066
hooks:
6167
- id: nbstripout
6268
exclude: (docs)
6369
- repo: https://github.com/crate-ci/typos
64-
rev: v1
70+
rev: v1.46.1
6571
hooks:
6672
- id: typos
6773
exclude: (\.ipynb)

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ build:
1919
- UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs
2020
build:
2121
html:
22-
- UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv run --group docs zensical build
22+
- UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uvx --from rust-just just docs
2323
post_build:
2424
- mkdir -p "${READTHEDOCS_OUTPUT}/html"
2525
- cp -a docs/build/. "${READTHEDOCS_OUTPUT}/html/"

CHANGELOG.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,17 @@ chronological order. Releases follow [semantic versioning](https://semver.org/)
55
releases are available on [PyPI](https://pypi.org/project/pytask) and
66
[Anaconda.org](https://anaconda.org/conda-forge/pytask).
77

8-
## Unreleased
9-
8+
## 0.6.0 - 2026-05-01
9+
10+
- [#875](https://github.com/pytask-dev/pytask/pull/875) improves the documentation
11+
homepage cards by making the full tile clickable and fixes the plugin list warning
12+
admonition formatting.
13+
- [#874](https://github.com/pytask-dev/pytask/pull/874) improves the lockfile
14+
documentation by restructuring related guides around user workflows and introducing
15+
`pytask.lock` in the tutorials.
16+
- [#868](https://github.com/pytask-dev/pytask/pull/868) resets the global marker
17+
configuration during unconfigure so `--strict-markers` no longer leaks into later
18+
marker access in the same process.
1019
- [#837](https://github.com/pytask-dev/pytask/pull/837) skips incremental live
1120
rendering on non-interactive output while preserving the final build table and
1221
live-manager lifecycle.

_typos.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
[default.extend-words]
22
ines = "ines"
33
thes = "thes" # profiling-tasks.md
4+
scap = "scap"

docs/AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
## General
44

5+
- The structure of the documentation follows https://diataxis.fr/. When writing or
6+
editing an article, read the relevant guidance from the Diataxis Framework before:
7+
https://diataxis.fr/tutorials, https://diataxis.fr/how-to-guides/,
8+
https://diataxis.fr/explanation/, https://diataxis.fr/reference/.
9+
https://diataxis.fr/compass/ tells you where belongs what and how do they relate.
510
- Document only public APIs and user-facing behavior - exclude internals, framework
611
abstractions, and implementation plumbing - Users need actionable documentation on
712
what they can use, not confusing details about internal mechanics they can't control

0 commit comments

Comments
 (0)