MyST in sphinx reference local file problem

[murphyzhao]

Use MyST in sphinx
I want to reference the local files in _static in the Markdown file, but I encountered some problems. The errors are as follows:

test.md:6: WARNING: 'myst' reference target not found: ../../_static/test.pdf

As shown above, I want to quote a local PDF file in a Markdown file test.md, what should I do?

thanks.

[choldgraf]

Ah in Sphinx the easiest way to do this is with the {download} role - try that

[murphyzhao]

it works, thanks.

[kimrojas]

Thank you for this discussion thread. I tried the same code but it seems the download icon doesn't appear?

[parmentelat]

hi there

the selected answer above worked fine for me too

however, given that my input is a jupyter notebook, I'm looking for a solution that would kind of look the same under both environment, because from the notebook this magic escape does not render too well:

if that is relevant, my notebooks are written by jupytext in md:myst format; is there any plugin I need to enable through a setting of some kind, or ?

many thanks in advance !

[NickleDave]

@parmentelat are you using MyST-NB?
https://myst-nb.readthedocs.io/en/latest/quickstart.html

If so, do you already have myst_nb (and not myst_parser) in your conf.py?

extensions = [
    ...,
    "myst_nb"
]

[parmentelat]

@NickleDave
thanks for the feedback !
the thing is, I am using jupyter-book, which I realize I did not make clear enough in the first place
anyways, jupyter-book will IIUC run sphinx under the hood but I am not aware of the exact settings that are passed to sphinx in this process; so I don't know how to answer your question :)

[NickleDave]

Jupyter book uses MyST-NB
https://jupyterbook.org/en/stable/file-types/myst-notebooks.html?highlight=MyST-NB

However I think you are asking for Jupyter Lab to render MyST in a live notebook?
When you say "look the same under both environment", I mean.

Sorry I missed that detail before.

I think such a plug-in is still a work in progress. See https://github.com/executablebooks/jupyterlab-myst
My understanding is that the plug-in might ultimately need to be written in javascript, see also https://myst.tools/docs/mystjs

[parmentelat]

thanks for pointing me to jupyterlab-myst, I will definitely give that a try :)

[NickleDave]

Sure, AFAICT it's more of a repo to organize dev thoughts right now but that would be one place to watch.

Maybe @rowanc1 can comment on future plans for JupyterLab-myst integration and what tools will be used; I thought I saw a recent blog post related to this but not finding it now

[rowanc1]

There are a few comments on the current work going on for us to align all of these projects here:
jupyter-book/jupyterlab-myst#57

As you note, the frontend of Jupyter needs this accessible in javascript, so we are planning to use the mystjs work that is ongoing!

The latest extension build is quite exciting (I think!), you can try it on binder and see some of the example notebooks. The extension can now see live previews and hover-references, and many of the extensions used in JupyterBook are enabled by default -- so hopefully it is a good initial experience!

[NickleDave]

Good to know, thank you!