MyST mini-roadmap

[stefanv]

Here we'll gather some work items related to myst for the summit. Also see sub-issues below.

• Port lecture notes to myst
  • PoC from last summit

Also see the Jupyter Book Scientific Python meta-issue

[bsipocz]

See the discussion in #5, too about myst for the lecture notes.

[bsipocz]

Would interactive documentation fall into this same tracker issue? It's not like we can resolve the API docs with mystmd questions during the summit, yet they feel connected.

Last year's issue: scientific-python/summit-2024#19

[stefanv]

It's not like we can resolve the API docs with mystmd

I am hoping that we can make progress on that specific item!

[agriyakhetarpal]

Hi! 👋🏻

While I'm not among the list of the attendees for the summit, I think I can comment briefly on the aspect of interactive documentation, having worked in this area for quite a while now:

• Interactivity is not limited to API docs alone, but also involves notebooks and tutorials, etc., as it's possible to use JupyterLite with jupyterlite-sphinx, Sphinx-Gallery and also MyST-JS.
• We've recently been up to speed on writing a SPEC around this topic, for which I'll be putting up a PR and I'll hope that it goes live soon after. The document will contain a bunch of recommendations and background information on how to set up interactive documentation deployments.
• However, we haven't explored the tooling around MyST-JS in the SPEC as much as beyond a brief suggestion, as the document focuses on Sphinx-based workflows and has a lot of ground to cover. Another reason is that there is hardly any content/material in the Scientific Python space utilising MyST. Someone recently asked at Add projects' interactive documentation Quansight-Labs/czi-scientific-python-mgmt#19 (comment) whether https://lectures.scientific-python.org/ could also be supported for this. So, progress on this front during the summit via Start conversion to markdown scipy-lectures/scientific-python-lectures#781 is very much appreciated.

[stefanv]

xref: Jupyter Book and MyST Team Priorities

The Jupyter Book projects board, where we can see priorities previously determined by @choldgraf, @agoose77, and others.

[stefanv]

Chris's higher level summary doc

Working Google doc for the week