search

jupyter-book / mystmd

Command line tools for working with MyST Markdown.
https://mystmd.org/guide
MIT License
191 stars 62 forks source link

Show off execution for multiple languages / kernels in our documentation #1493

Open choldgraf opened 2 weeks ago

choldgraf commented 2 weeks ago

Some users aren't sure whether MyST works with non-Python languages, since this is what we use in our execution documents. We should show off other languages. Here's a quick proposal for adding documentation that shows off execution in many languages:

  1. Defined a reference section for execution.
  2. Add a sub-page for each of the major languages we want to highlight (Python, Julia, R to start?) that generates a similar plot.
  3. Label various cells on each of those sub-pages.
  4. In our execution docs, we embed one cell from each of those languages
  5. In that page, add a list of common kernels and links (or info) for how to install them.
roaldarbol commented 2 weeks ago

There’s inspiration to find in the Pixi docs which has a page exactly for this: https://pixi.sh/latest/ide_integration/jupyterlab/#basic-usage