search

executablebooks / meta

A community dedicated to supporting tools for technical and scientific communication and interactive computing
https://executablebooks.org
129 stars 164 forks source link

Roadmaps and goals for next phase #65

Closed choldgraf closed 1 year ago

choldgraf commented 4 years ago

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 commented 4 years ago

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:

balint.szoke@gmail.com

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 notifications@github.com 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 commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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

mmcky commented 4 years ago

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 commented 4 years ago

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

chrisjsewell commented 4 years ago

Better integration with Jupyter front ends:

phaustin commented 4 years ago

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 commented 4 years ago

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

chrisjsewell commented 4 years ago

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 commented 4 years ago

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

chrisjsewell commented 4 years ago

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 commented 4 years ago

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

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.