Skip to content

Commit 2ac3aa4

Browse files
committed
docs(gallery): derive the gallery from the notebook sources (#746)
The Gallery page duplicated the per-notebook cards that also live in the notebooks submodule's section index pages, and the two lists drifted across repos: a notebook added to the submodule but not carded in gallery.md was silently missing from the gallery (e.g. 'Interactive region annotation'). Include the section card blocks from the submodule (scverse/spatialdata-plot-notebooks#11 added the markers and root-relative paths) instead of maintaining a second copy, and bump the submodule pin. gallery.html now renders these exact tiles from a single source, so a newly added notebook appears automatically and the gallery can never fall out of sync. Removes the now-orphaned _static/gallery images (the section cards use _static/img). Fixes #746.
1 parent 227434d commit 2ac3aa4

7 files changed

Lines changed: 9 additions & 56 deletions

File tree

-50.2 KB
Binary file not shown.
-84 KB
Binary file not shown.
-228 KB
Binary file not shown.
-31 KB
Binary file not shown.
-548 KB
Binary file not shown.

docs/gallery.md

Lines changed: 8 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -10,69 +10,22 @@ against the latest `spatialdata-plot` release.
1010

1111
## Tutorials
1212

13-
Entry-point material for learning the API on synthetic data.
13+
Learn the API on synthetic data. Start with *Getting started*.
1414

15-
::::{grid} 1 2 2 2
16-
:gutter: 3
17-
18-
:::{grid-item-card} Getting started
19-
:link: notebooks/tutorials/getting_started
20-
:link-type: doc
21-
:img-top: _static/gallery/getting_started.png
22-
23-
The fluent `.pl` API, layering, and styling on the in-memory `blobs`
24-
dataset. Ideal first read.
25-
:::
26-
27-
:::{grid-item-card} Colour and palettes
28-
:link: notebooks/tutorials/color_and_palette
29-
:link-type: doc
30-
:img-top: _static/gallery/color_and_palette.png
31-
32-
How `color=` resolves, the v0.3.0 `groups` behaviour, and building
33-
perceptually well-spaced or colourblind-safe palettes with
34-
`make_palette` and `make_palette_from_data`.
35-
:::
36-
37-
:::{grid-item-card} Speeding up rendering
38-
:link: notebooks/tutorials/performance
39-
:link-type: doc
40-
:img-top: _static/gallery/performance.png
41-
42-
Keep rendering fast on large data: automatic rasterization and scale
43-
selection for images, and the `datashader` backend for large collections
44-
of shapes and points.
15+
:::{include} notebooks/tutorials/index.md
16+
:start-after: <!-- gallery-cards-start -->
17+
:end-before: <!-- gallery-cards-end -->
4518
:::
4619

47-
::::
48-
4920
## Examples
5021

51-
Worked examples on real datasets you'd actually analyse.
52-
53-
::::{grid} 1 2 2 2
54-
:gutter: 3
22+
Apply the API to real datasets you'd actually analyse.
5523

56-
:::{grid-item-card} Visium mouse brain
57-
:link: notebooks/examples/visium_mouse_brain
58-
:link-type: doc
59-
:img-top: _static/gallery/visium_mouse_brain.png
60-
61-
Render H&E tissue, overlay spots, color by gene expression and by cluster,
62-
and finish with a publication-style figure.
24+
:::{include} notebooks/examples/index.md
25+
:start-after: <!-- gallery-cards-start -->
26+
:end-before: <!-- gallery-cards-end -->
6327
:::
6428

65-
:::{grid-item-card} Interactive region annotation
66-
:link: notebooks/examples/interactive_annotate
67-
:link-type: doc
68-
:img-top: _static/gallery/interactive_annotate.png
69-
70-
Draw regions of interest directly on a `spatialdata-plot` canvas with
71-
`sdata.pl.annotate(...)` and persist them as a `ShapesModel` element.
72-
:::
73-
74-
::::
75-
7629
```{toctree}
7730
:hidden:
7831
:maxdepth: 2

0 commit comments

Comments
 (0)