From 5cca0336a59042e3fed627b2cc14bb503b4c7cff Mon Sep 17 00:00:00 2001 From: Tom Herold Date: Mon, 22 Sep 2025 10:50:24 +0200 Subject: [PATCH] enable image captions for docs --- docs/mkdocs.yml | 1 + .../webknossos-py/examples/learned_segmenter.md | 17 +++++++++-------- .../webknossos-py/examples/upload_image_data.md | 3 +++ docs/uv.lock | 6 +++--- 4 files changed, 16 insertions(+), 11 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index a53cc13bb..86c81c80f 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -126,6 +126,7 @@ markdown_extensions: - pymdownx.keys - pymdownx.tabbed: alternate_style: true + - pymdownx.blocks.caption - toc: title: ON THIS PAGE permalink: true diff --git a/docs/src/webknossos-py/examples/learned_segmenter.md b/docs/src/webknossos-py/examples/learned_segmenter.md index 0e3680b06..ef5477f79 100644 --- a/docs/src/webknossos-py/examples/learned_segmenter.md +++ b/docs/src/webknossos-py/examples/learned_segmenter.md @@ -2,14 +2,15 @@ This example trains a segmenter from a volume annotation and applies it to the whole dataset. -
- ![Volume annotation used for training](./learned_segmenter_annotation.png) -
Volume annotation used for training
-
-
- ![Result of the trained segmenter on the full dataset](./learned_segmenter_result.png) -
Result of the trained segmenter on the full dataset
-
+![Volume annotation used for training](./learned_segmenter_annotation.png) +/// caption +Volume annotation used for training +/// + +![Result of the trained segmenter on the full dataset](./learned_segmenter_result.png) +/// caption +Result of the trained segmenter on the full dataset +/// It builds upon the two previous examples using the [Dataset API](dataset_usage.md) and [dataset upload](upload_image_data.md). Additionally, it downloads [this manual volume annotation of a subset of the skin example dataset](https://webknossos.org/annotations/Explorational/616457c2010000870032ced4) which is used for training. diff --git a/docs/src/webknossos-py/examples/upload_image_data.md b/docs/src/webknossos-py/examples/upload_image_data.md index 8b7ef7489..9e11d7cb8 100644 --- a/docs/src/webknossos-py/examples/upload_image_data.md +++ b/docs/src/webknossos-py/examples/upload_image_data.md @@ -9,3 +9,6 @@ webknossos/examples/upload_image_data.py ``` ![Cell Dataset uploaded to WEBKNOSSOS](./upload_image_data_dataset.jpg) +/// caption +Cell Dataset uploaded to WEBKNOSSOS +/// diff --git a/docs/uv.lock b/docs/uv.lock index 4644a1853..9de52a55a 100644 --- a/docs/uv.lock +++ b/docs/uv.lock @@ -1152,15 +1152,15 @@ wheels = [ [[package]] name = "pymdown-extensions" -version = "10.4" +version = "10.16.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "markdown" }, { name = "pyyaml" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/85/71/5f48080bde77b07ca1eba6d7cb5c5598ac6c8f2a399846159b3c8b45e171/pymdown_extensions-10.4.tar.gz", hash = "sha256:bc46f11749ecd4d6b71cf62396104b4a200bad3498cb0f5dad1b8502fe461a35", size = 785151, upload-time = "2023-11-10T23:40:31.345Z" } +sdist = { url = "https://files.pythonhosted.org/packages/55/b3/6d2b3f149bc5413b0a29761c2c5832d8ce904a1d7f621e86616d96f505cc/pymdown_extensions-10.16.1.tar.gz", hash = "sha256:aace82bcccba3efc03e25d584e6a22d27a8e17caa3f4dd9f207e49b787aa9a91", size = 853277, upload-time = "2025-07-28T16:19:34.167Z" } wheels = [ - { url = "https://files.pythonhosted.org/packages/98/2d/2929de81618c7213176899dd6372d6ec9c8f24337841dd74634fb69864ae/pymdown_extensions-10.4-py3-none-any.whl", hash = "sha256:cfc28d6a09d19448bcbf8eee3ce098c7d17ff99f7bd3069db4819af181212037", size = 240838, upload-time = "2023-11-10T23:40:29.166Z" }, + { url = "https://files.pythonhosted.org/packages/e4/06/43084e6cbd4b3bc0e80f6be743b2e79fbc6eed8de9ad8c629939fa55d972/pymdown_extensions-10.16.1-py3-none-any.whl", hash = "sha256:d6ba157a6c03146a7fb122b2b9a121300056384eafeec9c9f9e584adfdb2a32d", size = 266178, upload-time = "2025-07-28T16:19:31.401Z" }, ] [[package]]