Skip to content

Add card layout to tutorials/ and examples/ index pages#3

Merged
timtreis merged 1 commit into
mainfrom
feat/index-cards
May 11, 2026
Merged

Add card layout to tutorials/ and examples/ index pages#3
timtreis merged 1 commit into
mainfrom
feat/index-cards

Conversation

@timtreis
Copy link
Copy Markdown
Member

@timtreis timtreis commented May 11, 2026

Summary

Mirrors the gallery landing page's tile pattern in the per-section index pages (`tutorials/index.md`, `examples/index.md`) so each section page renders cards with thumbnails — not just a plain toctree.

Changes

File Change
`tutorials/getting_started.png` New 86 KB thumbnail (copied from lib repo's `docs/_static/gallery/`)
`examples/visium_mouse_brain.png` New 156 KB thumbnail (copied from lib repo's `docs/_static/gallery/`)
`tutorials/index.md` Replace plain toctree with `{grid}` + `{grid-item-card}`, hidden toctree underneath for navigation
`examples/index.md` Same treatment for the Visium card

Verified locally with the lib's sphinx build under `-W`: both index pages render the cards with thumbnails.

Note on duplication

Thumbnails now live in two places:

  • Lib repo's `docs/_static/gallery/` (used by `docs/gallery.md`)
  • Notebooks repo's `tutorials/` and `examples/` (used by section index pages)

Sphinx auto-renames the second copy in the build output (`getting_started1.png`), so there's no clash, just ~240 KB duplication in build artefacts. Consolidation is a future cleanup if it becomes annoying.

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.
@github-actions
Copy link
Copy Markdown

📖 Docs preview: https://scverse.org/spatialdata-plot-notebooks/pr-3/gallery.html

Built from 8883d7a; redeployed on every push.

github-actions Bot pushed a commit that referenced this pull request May 11, 2026
@timtreis timtreis merged commit 3df9d61 into main May 11, 2026
3 checks passed
@timtreis timtreis deleted the feat/index-cards branch May 11, 2026 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant