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

Consider myst for doc rendering #396

Open
delucchi-cmu opened this issue Aug 7, 2024 · 2 comments
Open

Consider myst for doc rendering #396

delucchi-cmu opened this issue Aug 7, 2024 · 2 comments

Comments

@delucchi-cmu
Copy link
Contributor

@bsipocz has had success with using myst, in combination with sphinx, for readthedocs rendering.

This would enable notebooks to be source-controlled as markdown files, instead of hard-to-read ipynb.

@delucchi-cmu
Copy link
Contributor Author

From Brigitta:

here are the notebook infra: https://myst-nb.readthedocs.io/en/latest/index.html, and https://executablebooks.org/en/latest/
(and for CI: numpy-tutorials, NASA NAVO workshop, IRSA tutorials all use the same setup of nbval for pytest and myst for rendering/executing)

@bsipocz
Copy link
Member

bsipocz commented Aug 7, 2024

fwiw it all started with the astroML book as notebooks :)

(and getting up some infrastructure template is on our radar for a while with the other numpy folks, we just couldn't find the resources/time to make it happen yet)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

2 participants