https://github.com/executablebooks/myst-nb

Parse and execute ipynb files in Sphinx
https://github.com/executablebooks/myst-nb

jupyter-notebooks markdown sphinx sphinx-extension

Last synced: 3 days ago
JSON representation

Parse and execute ipynb files in Sphinx

• Host: GitHub
• URL: https://github.com/executablebooks/myst-nb
• Owner: executablebooks
• License: bsd-3-clause
• Created: 2020-02-18T04:01:18.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-06T16:41:40.000Z (4 days ago)
• Last Synced: 2025-01-06T17:46:58.924Z (4 days ago)
• Topics: jupyter-notebooks, markdown, sphinx, sphinx-extension
• Language: Jupyter Notebook
• Homepage: https://myst-nb.readthedocs.io
• Size: 3.01 MB
• Stars: 217
• Watchers: 10
• Forks: 84
• Open Issues: 137
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MyST-NB

[![Github-CI][github-ci]][github-link]

[![Coverage Status][codecov-badge]][codecov-link]

[![Documentation Status][rtd-badge]][rtd-link]

[![PyPI][pypi-badge]][pypi-link]

[![Conda Version][conda-badge]][conda-link]

A collection of tools for working with Jupyter Notebooks in Sphinx.

The primary tool this package provides is a Sphinx parser for `ipynb` files.

This allows you to directly convert Jupyter Notebooks into Sphinx documents.

It relies heavily on the [`MyST` parser](https://github.com/executablebooks/myst-parser).

For more information, [see the MyST-NB documentation](https://myst-nb.readthedocs.io/en/latest/)

## Contributing

We welcome all contributions!

See the [Contributing Guide](https://myst-nb.readthedocs.io/en/latest/reference/contributing.html) for more details.

[github-ci]: https://github.com/executablebooks/MyST-NB/workflows/continuous-integration/badge.svg?branch=master

[github-link]: https://github.com/executablebooks/MyST-NB

[rtd-badge]: https://readthedocs.org/projects/myst-nb/badge/?version=latest

[rtd-link]: https://myst-nb.readthedocs.io/en/latest/?badge=latest

[codecov-badge]: https://codecov.io/gh/executablebooks/MyST-NB/branch/master/graph/badge.svg

[codecov-link]: https://codecov.io/gh/executablebooks/MyST-NB

[pypi-badge]: https://img.shields.io/pypi/v/myst-nb.svg

[pypi-link]: https://pypi.org/project/myst-nb

[conda-badge]: https://img.shields.io/conda/vn/conda-forge/myst-nb.svg

[conda-link]: https://anaconda.org/conda-forge/myst-nb