Enable image captions for docs #1369
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
normanrz
approved these changes
Sep 22, 2025
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
7 tasks
hotzenklotz
added a commit
to scalableminds/webknossos
that referenced
this pull request
Sep 22, 2025
This PR adds image captions to the webknossos documentation. We just enabled this `mkdocs` features in the [wk-libs](scalableminds/webknossos-libs#1369) and this is the follow up here. Most captions were auto-extracted from the existing images title. ### Example <img width="1256" height="837" alt="Screenshot 2025-09-22 at 12 01 49" src="https://github.com/user-attachments/assets/fbf02dba-57b4-49e9-988a-9e435c8325b4" /> ### Steps to test: - nothing really ### Issues: - None ------ (Please delete unneeded items, merge only when none are left open) - [ ] Added changelog entry (create a `$PR_NUMBER.md` file in `unreleased_changes` or use `./tools/create-changelog-entry.py`) - [ ] Added migration guide entry if applicable (edit the same file as for the changelog) - [x] Updated [documentation](../blob/master/docs) if applicable - [ ] Adapted [wk-libs python client](https://github.com/scalableminds/webknossos-libs/tree/master/webknossos/webknossos/client) if relevant API parts change - [ ] Removed dev-only changes like prints and application.conf edits - [ ] Considered [common edge cases](../blob/master/.github/common_edge_cases.md) - [ ] Needs datastore update after deployment --------- Co-authored-by: Philipp Otto <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
pymdown-extensionslib used bymkdocsto v10.12 to enable the captions.Example
Todos:
Make sure to delete unnecessary points or to check all before merging: