Recode MATLAB generated images so they get picked up as thumbnails#21
Merged
wkearn merged 1 commit intoTopoToolbox:mainfrom Mar 19, 2026
Merged
Recode MATLAB generated images so they get picked up as thumbnails#21wkearn merged 1 commit intoTopoToolbox:mainfrom
wkearn merged 1 commit intoTopoToolbox:mainfrom
Conversation
This PR adds a jq postprocessing step of the generated notebooks. This extracts the embedded image data and replaces it with a different mimetype (image/png) so that it gets recognized as an image by nbsphinx. jq is called with the `system` function. jq is installed by default on the CI machines that we build the gallery on but may not be installed on all developer machines. This solution is somewhat fragile as it depends on MATLAB not changing its Jupyter notebook output format too much. Signed-off-by: William Kearney <william.kearney@uni-potsdam.de>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR adds a jq postprocessing step of the generated notebooks. This extracts the embedded image data and replaces it with a different mimetype (image/png) so that it gets recognized as an image by nbsphinx.
jq is called with the
systemfunction. jq is installed by default on the CI machines that we build the gallery on but may not be installed on all developer machines.This solution is somewhat fragile as it depends on MATLAB not changing its Jupyter notebook output format too much.