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

Investigate MyST for doc building #348

Closed
jklaise opened this issue Feb 10, 2021 · 2 comments
Closed

Investigate MyST for doc building #348

jklaise opened this issue Feb 10, 2021 · 2 comments
Labels
Priority: Low Type: Docs Anything related to documentation

Comments

@jklaise
Copy link
Contributor

jklaise commented Feb 10, 2021

MyST is a new Markdown format emulating the functionality of RST and fully compatible with Sphinx. We could use this instead of m2r (unmaintained) or recommonmark to support .md file parsing in docs. This could allow a more streamlined workflow of writing docs in Markdown (instead of RST) but maintain flexibility and avoid Sphinx warnings parsing vanilla Markdown files. https://github.com/executablebooks/myst-parser

They also support parsing Jupyter notebooks via https://github.com/executablebooks/myst-nb which could be a replacement for nbsphinx, but may lack some features we currently use (e.g. executablebooks/MyST-NB#297). It would be nice to remove the non-python pandoc dependency that is required by nbsphinx.

@ascillitoe
Copy link
Contributor

This is largely addressed by #482.

@jklaise do we want to close this, or keep open (or open new issue) to explore myst-nb? Looks like myst-nb isn't moving towards nbsphinx-link type support anytime soon, so we would have to think about build time copying around of example notebooks...

@jklaise
Copy link
Contributor Author

jklaise commented Oct 14, 2021

Yea I think we're good to close this as we've achieved the main goals. We can keep monitoring progress of myst-nb for the future.

It may be helpful to convert existing .ipynb documentation files into .md but probably a new issue would better describe it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Low Type: Docs Anything related to documentation
Projects
None yet
Development

No branches or pull requests

2 participants