Skip to content

Commit 5add279

Browse files
committed
Add card layout to tutorials/ and examples/ index pages
Mirrors the gallery landing page's tile pattern in the section index pages, so each section reads the same whether you arrived via the Gallery card or via the sidebar. Thumbnails (getting_started.png, visium_mouse_brain.png) are copied into the notebooks repo next to their respective notebooks. Sphinx auto-copies them into _images/ at build time when referenced from :img-top:. The lib's docs/_static/gallery/ thumbnails stay as the source-of-truth for the landing page; consolidation can come later if duplication becomes annoying.
1 parent 48fb273 commit 5add279

4 files changed

Lines changed: 32 additions & 5 deletions

File tree

examples/index.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
# Examples
22

3-
Worked examples showing `spatialdata-plot` on real spatial-omics datasets.
4-
Use these to see how the API composes on data you'd actually analyse.
3+
Worked examples on real datasets you'd actually analyse.
4+
5+
::::{grid} 1 2 2 2
6+
:gutter: 3
7+
8+
:::{grid-item-card} Visium mouse brain
9+
:link: visium_mouse_brain
10+
:link-type: doc
11+
:img-top: visium_mouse_brain.png
12+
13+
Render H&E tissue, overlay spots, color by gene expression and by cluster,
14+
and finish with a publication-style figure.
15+
:::
16+
17+
::::
518

619
```{toctree}
20+
:hidden:
721
:maxdepth: 1
822
923
visium_mouse_brain

examples/visium_mouse_brain.png

153 KB
Loading

tutorials/getting_started.png

84 KB
Loading

tutorials/index.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
11
# Tutorials
22

3-
End-to-end workflows demonstrating `spatialdata-plot` on real spatial-omics
4-
datasets. Each tutorial walks through loading a published dataset, layering
5-
spatial elements, and styling a publication-ready figure.
3+
Entry-point material for learning the API on synthetic data.
4+
5+
::::{grid} 1 2 2 2
6+
:gutter: 3
7+
8+
:::{grid-item-card} Getting started
9+
:link: getting_started
10+
:link-type: doc
11+
:img-top: getting_started.png
12+
13+
The fluent `.pl` API, layering, and styling on the in-memory `blobs`
14+
dataset. Ideal first read.
15+
:::
16+
17+
::::
618

719
```{toctree}
20+
:hidden:
821
:maxdepth: 1
922
1023
getting_started

0 commit comments

Comments
 (0)