Skip to content

Commit 75de4cc

Browse files
committed
Auto-pull notebooks main, add card gallery, link from README
C2 — Render notebooks-repo main, not the pinned SHA .readthedocs.yaml gains a `post_checkout` job that runs `git submodule update --init --remote --recursive` so RTD always renders the latest gallery without requiring a submodule-bump PR here. Mirrored in the docs CI job in build.yaml. Trade-off: docs at older lib tags are no longer bit-for-bit reproducible for the gallery. N1 — Card gallery with thumbnails (matches scverse/spatialdata) Add sphinx-design to doc deps and to the extension list. Rewrite gallery.md to use {grid}/{grid-item-card} with an :img-top: thumbnail. Thumbnail PNG (getting_started.png) committed under docs/_static/gallery. N6 — README points at the gallery New `link-gallery` link target alongside the existing API reference; existing spatialdata-notebooks link reframed as a "broader analyses" pointer. Fixes the "Visiualizations" typo while there.
1 parent 62a9194 commit 75de4cc

7 files changed

Lines changed: 42 additions & 3 deletions

File tree

.github/workflows/build.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ jobs:
3232
with:
3333
submodules: true
3434
fetch-depth: 0
35+
- name: Pull latest notebooks
36+
# Match RTD: render whatever is on notebooks-repo main, not the pinned SHA.
37+
run: git submodule update --init --remote --recursive
3538
- name: Install uv
3639
uses: astral-sh/setup-uv@v7
3740
- name: Build docs

.readthedocs.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ build:
66
python: "3.13"
77
nodejs: latest
88
jobs:
9+
post_checkout:
10+
# Always render the latest notebooks-repo main, not the SHA pinned in
11+
# this repo's index. Trade-off: docs at older lib tags are not bit-for-bit
12+
# reproducible for the gallery — a re-build shows whatever the notebooks
13+
# repo's main looked like at build time.
14+
- git submodule update --init --remote --recursive
915
create_environment:
1016
- asdf plugin add uv
1117
- asdf install uv latest

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ In concordance with the general SpatialData philosophy, all modalities of the ma
3030

3131
For more information on the `spatialdata-plot` library, please refer to the [documentation](https://spatialdata.scverse.org/projects/plot/en/latest/index.html). In particular, the
3232

33+
- [Gallery][link-gallery] — executable example notebooks demonstrating the plotting capabilities.
3334
- [API documentation][link-api].
34-
- [Example notebooks][link-notebooks] (section "Visiualizations")
35+
- [SpatialData example notebooks][link-notebooks] (section "Visualizations") for plotting in the context of broader analyses.
3536

3637
## Installation
3738

@@ -65,6 +66,7 @@ Marconato, L., Palla, G., Yamauchi, K.A. et al. SpatialData: an open and univers
6566
[issue-tracker]: https://github.com/scverse/spatialdata-plot/issues
6667
[link-docs]: https://spatialdata-plot.readthedocs.io
6768
[link-api]: https://spatialdata.scverse.org/projects/plot/en/stable/api.html
69+
[link-gallery]: https://spatialdata.scverse.org/projects/plot/en/stable/gallery.html
6870
[link-design-doc]: https://spatialdata.scverse.org/en/stable/design_doc.html
6971
[link-notebooks]: https://spatialdata.scverse.org/en/stable/tutorials/notebooks/notebooks.html
7072
[//]: # "numfocus-fiscal-sponsor-attribution"
84 KB
Loading

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
"sphinx.ext.intersphinx",
5757
"sphinx.ext.autosummary",
5858
"sphinx.ext.napoleon",
59+
"sphinx_design",
5960
"sphinxcontrib.bibtex",
6061
"sphinxcontrib.katex",
6162
"sphinx_autodoc_typehints",

docs/gallery.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,41 @@
11
# Gallery
22

33
Curated, runnable examples demonstrating `spatialdata-plot` on real
4-
spatial-omics datasets (Visium, Xenium, MERFISH) and on the lightweight
5-
`blobs` dataset for first-time users.
4+
spatial-omics datasets and on the lightweight `blobs` dataset.
65

76
Sources live in
87
[`scverse/spatialdata-plot-notebooks`](https://github.com/scverse/spatialdata-plot-notebooks);
98
every notebook is executable end-to-end and re-executed on a weekly schedule
109
against the latest `spatialdata-plot` release.
1110

11+
## Tutorials
12+
13+
End-to-end workflows on real datasets.
14+
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+
::::
28+
29+
## Examples
30+
31+
```{note}
32+
No focused examples yet — contributions welcome! See
33+
[CONTRIBUTING](https://github.com/scverse/spatialdata-plot-notebooks/blob/main/CONTRIBUTING.md)
34+
in the notebooks repo for how to add one.
35+
```
36+
1237
```{toctree}
38+
:hidden:
1339
:maxdepth: 2
1440
1541
notebooks/tutorials/index

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ doc = [
5555
"sphinx-autodoc-typehints",
5656
"sphinx-book-theme>=1",
5757
"sphinx-copybutton",
58+
"sphinx-design",
5859
"sphinx-tabs",
5960
"sphinxcontrib-bibtex>=1",
6061
"sphinxcontrib-katex",

0 commit comments

Comments
 (0)