Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,14 @@ pre-commit install
toctree.

6. Place the gallery thumbnail and any other media (GIFs, screenshots, static
PNGs referenced from the notebook) under `_static/img/`. Reference them from
`index.md` and notebook markdown cells with relative paths
(e.g. `:img-top: ../_static/img/<slug>.png` from inside `examples/` or
`tutorials/`, and `![…](../_static/img/<slug>.gif)` from a notebook cell).
PNGs referenced from the notebook) under `_static/img/`. This repo is mounted
as a git submodule at `docs/notebooks/` in the `spatialdata-plot` Sphinx
build, so paths resolve against that mount:
- **Gallery cards in `index.md`** — use the absolute source-root path:
`:img-top: /notebooks/_static/img/<slug>.png`.
- **Notebook markdown cells** — use a path relative to the notebook:
`![…](../_static/img/<slug>.gif)`.

Do **not** drop assets next to the notebook itself.

7. Open a PR. CI will:
Expand Down
Binary file added _static/img/scalebars.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,15 @@ selection for images, and the `datashader` backend for large collections
of shapes and points.
:::

:::{grid-item-card} Scalebars
:link: /notebooks/tutorials/scalebars
:link-type: doc
:img-top: /notebooks/_static/img/scalebars.png

Add a physical scalebar with `scalebar_dx`, choose units, and style
placement, colour, length and fonts through `scalebar_params`.
:::

::::
<!-- gallery-cards-end -->

Expand All @@ -45,4 +54,5 @@ of shapes and points.
getting_started
color_and_palette
performance
scalebars
```
458 changes: 458 additions & 0 deletions tutorials/scalebars.ipynb

Large diffs are not rendered by default.

Loading