jupyter-book / jupyterlab-myst

Use MyST Markdown directly in Jupyter Lab

Home Page:https://jupyter-book.github.io/jupyterlab-myst/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Unknown directive: `eval-rst`

raphaelquast opened this issue · comments

Description

Hey, while trying to couple some automatically generated python docs to myst-markdown files I realized that jupyterlab-myst does not seem to recognize the {eval-rst} directive (both in .md or .ipynb files).

If I render the same with sphinx and myst_nb, all works as expected.

Here's a snapshot of what I mean:

image

...here's the correct output I get with sphinx + myst_nb:

Am I missing some config or is this directive simply not supported by jupyterlab-myst?

MyST-NB et al. are based on Sphinx, which internally supports ReST. MyST-MD is a newer toolchain that doesn't support ReST (unless there's something in the unified ecosystem that I've missed @rowanc1).

As such, it's not something that jupyterlab-myst is likely to support any time soon, unfortunately :)

Thanks @agoose77. @raphaelquast -- we would be very interested to hear which features are not supported in MyST so that we can implement them!

@agoose77 Thank you very much for the clarification (makes a lot of sense).

@rowanc1 So far I'm really happy with jupyterlab-myst (and the accompanying myst-nb parser for sphinx)... it really made my notebook-based examples in sphinx-docs much nicer and nowadays I'm using MyST syntax in almost all new content I add.

The only thing that bothered me until now is the issue concerning dynamically created markdown-tables (executablebooks/MyST-NB#570) but that's a myst-nb issues I guess.

I'll report back if I run into any troubles!

I am hoping that we can take a pass on improving the markdown rendering of eval-snippets soon. Right now we are explicitly not parsing the markdown (and have the same problem as myst-nb), however, we have done some changes recently in mystmd.org to allow those to change and be fixed in jupyterlab-myst and the mystmd CLI!

Really exciting that you are using MyST in a lot of different places now and things are (generally!) working out. 🚀