Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unknown directive: eval-rst #196

Closed
raphaelquast opened this issue Dec 4, 2023 · 4 comments
Closed

Unknown directive: eval-rst #196

raphaelquast opened this issue Dec 4, 2023 · 4 comments
Labels
bug Something isn't working

Comments

@raphaelquast
Copy link

raphaelquast commented Dec 4, 2023

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?

@raphaelquast raphaelquast added the bug Something isn't working label Dec 4, 2023
@agoose77
Copy link
Collaborator

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 :)

@rowanc1
Copy link
Member

rowanc1 commented Feb 12, 2024

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

@raphaelquast
Copy link
Author

raphaelquast commented Feb 12, 2024

@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!

@rowanc1
Copy link
Member

rowanc1 commented Feb 12, 2024

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. 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants