diff --git a/.cruft.json b/.cruft.json index 559ac6e..42aa986 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "/home/runner/work/cookiecutter-scverse/cookiecutter-scverse", - "commit": "af5404e37dd5144a952d2262665d5b78192d1da7", + "commit": "3f027afed977ad89c1aef7b48834a89b483d9634", "checkout": null, "context": { "cookiecutter": { @@ -36,7 +36,7 @@ "trim_blocks": true }, "_template": "/home/runner/work/cookiecutter-scverse/cookiecutter-scverse", - "_commit": "af5404e37dd5144a952d2262665d5b78192d1da7" + "_commit": "3f027afed977ad89c1aef7b48834a89b483d9634" } }, "directory": null diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index c6ecc2f..8168d13 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -14,7 +14,7 @@ jobs: package: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 with: filter: blob:none fetch-depth: 0 diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 1578b5f..6b5abfd 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -15,7 +15,7 @@ jobs: permissions: id-token: write # IMPORTANT: this permission is mandatory for trusted publishing steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 with: filter: blob:none fetch-depth: 0 diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 6bf473b..ab88fb4 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -23,7 +23,7 @@ jobs: outputs: envs: ${{ steps.get-envs.outputs.envs }} steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 with: filter: blob:none fetch-depth: 0 @@ -60,7 +60,7 @@ jobs: continue-on-error: ${{ contains(matrix.env.name, 'pre') }} # make "all-green" pass even if pre-release job fails steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 with: filter: blob:none fetch-depth: 0 diff --git a/docs/conf.py b/docs/conf.py index 283792a..98be18d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -59,7 +59,7 @@ "sphinxcontrib.bibtex", "sphinxcontrib.katex", "sphinx_autodoc_typehints", - "sphinx_tabs.tabs", + "sphinx_design", "IPython.sphinxext.ipython_console_highlighting", "sphinxext.opengraph", *[p.stem for p in (HERE / "extensions").glob("*.py")], diff --git a/docs/contributing.md b/docs/contributing.md index 303396b..5efb67d 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -33,8 +33,9 @@ it is still possible to use different tools to manage dependencies, such as `uv` In addition to the packages needed to _use_ this package, you need additional python packages to [run tests](#writing-tests) and [build the documentation](#docs-building). -:::::{tabs} -::::{group-tab} Hatch +:::::{tab-set} +::::{tab-item} Hatch +:sync: hatch On the command line, you typically interact with hatch through its command line interface (CLI). Running one of the following commands will automatically resolve the environments for testing and @@ -94,7 +95,8 @@ In this future, this may become easier through a hatch vscode extension. :::: -::::{group-tab} uv +::::{tab-item} uv +:sync: uv A popular choice for managing virtual environments is [uv][]. The main disadvantage compared to hatch is that it supports only a single environment per project at a time, @@ -113,7 +115,8 @@ The `.venv` directory is typically automatically discovered by IDEs such as VS C :::: -::::{group-tab} Pip +::::{tab-item} Pip +:sync: pip Pip is nowadays mostly superseded by environment manager such as [hatch][]. However, for the sake of completeness, and since it’s ubiquitously available, @@ -185,8 +188,9 @@ hatch env find hatch-test # list all possible test environment paths Alternatively, you can run all tests from the command line by executing -:::::{tabs} -::::{group-tab} Hatch +:::::{tab-set} +::::{tab-item} Hatch +:sync: hatch ```bash hatch test # test with the highest supported Python version @@ -196,7 +200,8 @@ hatch test --all # test with all supported Python versions :::: -::::{group-tab} uv +::::{tab-item} uv +:sync: uv ```bash uv run pytest @@ -204,7 +209,8 @@ uv run pytest :::: -::::{group-tab} Pip +::::{tab-item} Pip +:sync: pip ```bash source .venv/bin/activate @@ -298,8 +304,9 @@ please check out [this feature request][issue-render-notebooks] in the `cookiecu ### Building the docs locally -:::::{tabs} -::::{group-tab} Hatch +:::::{tab-set} +::::{tab-item} Hatch +:sync: hatch ```bash hatch run docs:build @@ -308,7 +315,8 @@ hatch run docs:open :::: -::::{group-tab} uv +::::{tab-item} uv +:sync: uv ```bash cd docs @@ -318,7 +326,8 @@ uv run sphinx-build -M html . _build -W :::: -::::{group-tab} Pip +::::{tab-item} Pip +:sync: pip ```bash source .venv/bin/activate diff --git a/pyproject.toml b/pyproject.toml index 03d6d64..cdcb0cc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -51,7 +51,7 @@ doc = [ "sphinx-autodoc-typehints", "sphinx-book-theme>=1", "sphinx-copybutton", - "sphinx-tabs", + "sphinx-design", "sphinxcontrib-bibtex>=1", "sphinxcontrib-katex", "sphinxext-opengraph",