Skip to content

fix image markdown format [ -> ( for 0.9.0 release notes - #447

Open
TimMonko wants to merge 1 commit into
gh-pagesfrom
fix-0.9.0-image-link
Open

fix image markdown format [ -> ( for 0.9.0 release notes#447
TimMonko wants to merge 1 commit into
gh-pagesfrom
fix-0.9.0-image-link

Conversation

@TimMonko

Copy link
Copy Markdown
Member

@TimMonko
TimMonko requested a review from jni August 28, 2026 02:12

</footer>
</body>
</html> No newline at end of file

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did this happen? I swear it wasn't Windows I used the online editor....

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clearly the online editor did it and adds trailing newlines, while the generator doesn't. Shouldn't make any difference at all.

bearings in seconds. If the viewer is empty, napari opens the built-in <em>Balls
(3D)</em> sample data so the walkthrough has something to show (<a class="reference external" href="https://github.com/napari/napari/pull/9290">#9290</a>).</p>
<p>![Screenshot of the napari viewer guided tour][../_static/images/guided-tour.png)</p>
<p>![Screenshot of the napari viewer guided tour](../_static/images/guided-tour.png)</p>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LOL it's html at this point, it only looks like markdown because it didn't render to html. See e.g. line 856:

<p><img alt="napari screenshot showing inherited labeled viewer axes" src="../_images/axis-labels.png" /></p>

So this should be:

Suggested change
<p>![Screenshot of the napari viewer guided tour](../_static/images/guided-tour.png)</p>
<p><img alt="Screenshot of the napari viewer guided tour" src="../_static/images/guided-tour.png" /></p>

Note also the change from _static/images to _images, which I don't understand. Clearly there is a build step changing that and copying the images somewhere... CC @melissawm 🤔

But it looks like _static/images are still there, as both of these work:

https://napari.org/stable/_static/images/axis-labels.png
https://napari.org/stable/_images/axis-labels.png

In this case, the file (guided-tour.png) wasn't copied, I presume because there was no link to it, so I'm leaving it as _static/images. Would be good to understand this all better though. I don't like that the images are being duplicated! (If that's indeed what's happening...)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll take a look, but I'm pretty sure that's just how myst/sphinx builds the html pages - it dumps all images into the _images folder just like it creates _downloads, _modules, _sources etc. So if you are using the image in markdown, you use the path defined in the sources; if you are using raw html, that gets rendered just at the end after the build is finished, which means you have to use the html path (_images). But I may be wrong!


</footer>
</body>
</html> No newline at end of file

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clearly the online editor did it and adds trailing newlines, while the generator doesn't. Shouldn't make any difference at all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants