Skip to content

Commit ec1f961

Browse files
Update instance repo from cookiecutter template
1 parent 2ad0e99 commit ec1f961

4 files changed

Lines changed: 25 additions & 16 deletions

File tree

.cruft.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"template": "/home/runner/work/cookiecutter-scverse/cookiecutter-scverse",
3-
"commit": "af5404e37dd5144a952d2262665d5b78192d1da7",
3+
"commit": "c9d52d04e146e655f203624ab4f46df868ec5752",
44
"checkout": null,
55
"context": {
66
"cookiecutter": {
@@ -36,7 +36,7 @@
3636
"trim_blocks": true
3737
},
3838
"_template": "/home/runner/work/cookiecutter-scverse/cookiecutter-scverse",
39-
"_commit": "af5404e37dd5144a952d2262665d5b78192d1da7"
39+
"_commit": "c9d52d04e146e655f203624ab4f46df868ec5752"
4040
}
4141
},
4242
"directory": null

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
"sphinxcontrib.bibtex",
6060
"sphinxcontrib.katex",
6161
"sphinx_autodoc_typehints",
62-
"sphinx_tabs.tabs",
62+
"sphinx_design",
6363
"IPython.sphinxext.ipython_console_highlighting",
6464
"sphinxext.opengraph",
6565
*[p.stem for p in (HERE / "extensions").glob("*.py")],

docs/contributing.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ it is still possible to use different tools to manage dependencies, such as `uv`
3333
In addition to the packages needed to _use_ this package,
3434
you need additional python packages to [run tests](#writing-tests) and [build the documentation](#docs-building).
3535

36-
:::::{tabs}
37-
::::{group-tab} Hatch
36+
:::::{tab-set}
37+
::::{tab-item} Hatch
38+
:sync: hatch
3839

3940
On the command line, you typically interact with hatch through its command line interface (CLI).
4041
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.
9495

9596
::::
9697

97-
::::{group-tab} uv
98+
::::{tab-item} uv
99+
:sync: uv
98100

99101
A popular choice for managing virtual environments is [uv][].
100102
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
113115

114116
::::
115117

116-
::::{group-tab} Pip
118+
::::{tab-item} Pip
119+
:sync: pip
117120

118121
Pip is nowadays mostly superseded by environment manager such as [hatch][].
119122
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
185188

186189
Alternatively, you can run all tests from the command line by executing
187190

188-
:::::{tabs}
189-
::::{group-tab} Hatch
191+
:::::{tab-set}
192+
::::{tab-item} Hatch
193+
:sync: hatch
190194

191195
```bash
192196
hatch test # test with the highest supported Python version
@@ -196,15 +200,17 @@ hatch test --all # test with all supported Python versions
196200

197201
::::
198202

199-
::::{group-tab} uv
203+
::::{tab-item} uv
204+
:sync: uv
200205

201206
```bash
202207
uv run pytest
203208
```
204209

205210
::::
206211

207-
::::{group-tab} Pip
212+
::::{tab-item} Pip
213+
:sync: pip
208214

209215
```bash
210216
source .venv/bin/activate
@@ -298,8 +304,9 @@ please check out [this feature request][issue-render-notebooks] in the `cookiecu
298304

299305
### Building the docs locally
300306

301-
:::::{tabs}
302-
::::{group-tab} Hatch
307+
:::::{tab-set}
308+
::::{tab-item} Hatch
309+
:sync: hatch
303310

304311
```bash
305312
hatch run docs:build
@@ -308,7 +315,8 @@ hatch run docs:open
308315

309316
::::
310317

311-
::::{group-tab} uv
318+
::::{tab-item} uv
319+
:sync: uv
312320

313321
```bash
314322
cd docs
@@ -318,7 +326,8 @@ uv run sphinx-build -M html . _build -W
318326

319327
::::
320328

321-
::::{group-tab} Pip
329+
::::{tab-item} Pip
330+
:sync: pip
322331

323332
```bash
324333
source .venv/bin/activate

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ doc = [
5151
"sphinx-autodoc-typehints",
5252
"sphinx-book-theme>=1",
5353
"sphinx-copybutton",
54-
"sphinx-tabs",
54+
"sphinx-design",
5555
"sphinxcontrib-bibtex>=1",
5656
"sphinxcontrib-katex",
5757
"sphinxext-opengraph",

0 commit comments

Comments
 (0)