You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
@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...
MyST is a new Markdown format emulating the functionality of RST and fully compatible with Sphinx. We could use this instead of
m2r
(unmaintained) orrecommonmark
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-parserThey 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-pythonpandoc
dependency that is required bynbsphinx
.The text was updated successfully, but these errors were encountered: