Roadmaps and goals for next phase

[choldgraf]

Hey all - I think that everybody has done a fantastic job of getting all of our tools out the door (and in a surprisingly short amount of time!). MyST is generally getting a great reception from the developer community (https://twitter.com/paulweveritt/status/1264181873619730432) and people are really positive about the pre-release for Jupyter Book! 🎉

As more people use the tools, and also potentially become interested in contributing, it'll be helpful for both us and them if we have an idea of where we wanna take things next. What are the directions in which we'd like the project to improve, evolve, etc? What are the major new features, or new bugs, that we'd like to work on?

So this issue is just a place to collect what you all think would be the biggest improvements over what we have right now. Eventually, we can convert this into one-or-more "roadmaps" or "wishlists" that we can use to signal the direction of the project.

I'll try to think about this myself over the next few days, and will add them below! It would be great to see your thoughts as well!

[thomassargent30]

Dear Chris and John, Is it possible to add this Balint Szoke to this stream of messages. ?Together with me, he is doing some testing of the jupyter book machinery so it would be good for him and good for us for him to join the community. Balint's e-mail is: [email protected] Chris, what you have created is remarkable. I am very impressed. I am trying to learn MyST and making some progress! Tom

…

On Mon, May 25, 2020 at 8:48 AM Chris Holdgraf ***@***.***> wrote: Hey all - I think that everybody has done a *fantastic* job of getting all of our tools out the door (and in a surprisingly short amount of time!). MyST is generally getting a great reception from the developer community (https://twitter.com/paulweveritt/status/1264181873619730432 <https://urldefense.proofpoint.com/v2/url?u=https-3A__twitter.com_paulweveritt_status_1264181873619730432&d=DwMFaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=hV4qLWg4zodvX-YQ-ETIbA&m=2sPHOKAbswZQ9PDospgR3oCTQPYAiVXCSp1QWPn-1H4&s=My856x4pk9DGBMkc5Hv2G1xWElJtMu78dfaAJzjebZM&e=>) and people are really positive about the pre-release for Jupyter Book! 🎉 As more people use the tools, and also potentially become interested in contributing, it'll be helpful for both us and them if we have an idea of where we wanna take things next. What are the directions in which we'd like the project to improve, evolve, etc? What are the major new features, or new bugs, that we'd like to work on? So this issue is just a place to collect what you all think would be the biggest improvements over what we have right now. Eventually, we can convert this into one-or-more "roadmaps" or "wishlists" that we can use to signal the direction of the project. I'll try to think about this myself over the next few days, and will add them below! — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_executablebooks_meta_issues_65&d=DwMFaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=hV4qLWg4zodvX-YQ-ETIbA&m=2sPHOKAbswZQ9PDospgR3oCTQPYAiVXCSp1QWPn-1H4&s=ZNHsDyn1Lcum2yF7iQSj54pTBzYczRGYztvd6gQyF1w&e=>, or unsubscribe <https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_notifications_unsubscribe-2Dauth_AA63MTX7XMDVZZQROPT27OLRTKAJ5ANCNFSM4NJSTBNQ&d=DwMFaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=hV4qLWg4zodvX-YQ-ETIbA&m=2sPHOKAbswZQ9PDospgR3oCTQPYAiVXCSp1QWPn-1H4&s=9FtM5KrR2W2O68c8qhRz5UrJW18gzpix_sWZ76NP_Ok&e=> .

[jstac]

Hi @thomassargent30, it will be great to have input from Balint. I'll message him and get him hooked up to the information flow.

[jstac]

It would be good to have high quality support for theorems / proofs / definitions / lemmas / etc. This comment from @najuzilu suggests that we might need to invest some effort:

I'm currently utilizing sphinxcontrib-proof for the lemmas, theorems, and definitions but I'm not satisfied with the package at all. It's such a headache referencing each element. Unlike figures, which can be easily referenced using {numref}, each lemma and definition can be referenced through {ref} which requires that I go back and forth to check which definition number is being referenced.

[jstac]

Multiple themes available off the shelf, similar to Sphinx. (@DrDrij is working on one for QuantEcon but that's the one thing we'll probably keep private 😬 )

[mmcky]

Multiple themes available off the shelf, similar to Sphinx. (@DrDrij is working on one for QuantEcon but that's the one thing we'll probably keep private 😬 )

In addition to the QuantEcon theme work ... @DrDrij will also be working on minimal, and dark style themes as part of his theme work.

[mmcky]

Beyond the improvements needed to develop LaTeX further, here are some additional ideas / feature requests for the roadmaps.

• improvements to user facing debug support for failing notebooks through jupyter-cache. Possible opening notebooks at the point of failure etc.
• support in myst-nb and jupyter-cache for automatic execution testing statistics similar to: https://python.quantecon.org/status.html
• support for automatic inclusion of environment information for html and latex
• development of a simple github action for automatic deployments of projects hosted on GitHub, and possible integration with gh-pages, s3 hosting

[chrisjsewell]

Better integration with Jupyter front ends:

• Improved extensions for writing myst with syntax that is better supported natively by the current Jupyter renderer:
  • Admonitions as "fenced divs":

    :::note
    my note, which will render **syntax**
    :::

  • Parsing native latex math: Ensure Math Is Parsed/Rendered Consistently MyST-NB#126 (comment)
  • Direct conversion of HTML <img> tags (including width, height, etc) to docutils image nodes (Best way to download notebooks created from myst-notebook files? MyST-NB#148 (comment))
• Addition of JupyterLab extensions for enhanced editor support:
  • Custom renderers
  • LSP-espque features (e.g. autocompletion, syntax highlighting, linting, etc) like in VSCode MyST and rst-language-server

[phaustin]

Multiple themes available off the shelf, similar to Sphinx. (@DrDrij is working on one for QuantEcon but that's the one thing we'll probably keep private 😬 )

+1 for a simple theme gallery -- we'll be posting an alpha version of our pagedown theme for myst_nb this week, and having a document that points to examples would be very useful.

[mmcky]

Does VSCode Myst support writing myst in an ipynb file that contains myst markup?

[chrisjsewell]

No not currently I’m afraid. I’m not sure if vscode-python currently offers any extension points for the notebook plugin, whereby we could add such support

[choldgraf]

I think much of what I've said has already been described above, but just to re-iterate:

• Better jupyter interfaces support - probably the most common thing people have started raising is wanting their notebooks to behave the same ways in Jupyter interfaces (Lab/Notebook are the most-common but it applies to vscode as well)
• Better cross-language (e.g. R, Julia) support
• Better internationalization and hosted online docs support (e.g. multiple languages in a book)
• More interactivity between markdown and notebook outputs - right now there's still a fairly strong separation between code outputs and markdown, but it would be really cool to incorporate principles of "explorable explanations" and tangle.js-style content into Jupyter Book. One promising direction is Iooxa which has several open source webcomponents for adding this to web pages.

[chrisjsewell]

Another point on the roadmap is to update the stack to be compatible with sphinx version 3 (released earlier this year). I didn't want to jump into this straight away, since 3.0.0 seemed to have a lot of bugs, but maybe when 3.1 is released (https://github.com/sphinx-doc/sphinx/milestone/78) it would be a good time to start thinking about this

[rowanc1]

Just a sidenote to @choldgraf's point above on iooxa super excited to be following along with this community and hope that we can help contribute something down the line. What we are creating at the moment is a visual editor for "myst-like" content, and are hoping to support myst natively on our side moving forward.

Currently working on this:

Down the line we are envisioning some sort of Jupyter integration to enable users who might not be familiar with the myst syntax (or github) to contribute back to projects easily. I am looking to help out where I can (esp. on pieces that help further explorable explanations!), and will coordinate with @choldgraf.