Overview#

Jupyter Notebook Publishing

A Sphinx and Docutils extension for compiling Jupyter Notebooks into high quality documentation formats.

Write

Mix Jupyter notebooks with text-based notebooks, Markdown and RST documents.
Use MyST Markdown syntax to support technical authoring features such as cross-referencing, figures, and admonitions.

Learn more »

Compute

Generate dynamic outputs using Jupyter kernels, with configurable execution handling.
Cache execution outputs, for fast re-builds.

Learn more »

Render

Convert Jupyter execution outputs to embedded content.
Insert outputs as variables into your documents.
Build single or collections of documents into multiple formats, including HTML websites and PDF books.

Learn more »

MyST-NB is a module within the Executable Books Project, an international collaboration to build open source tools that facilitate publishing computational narratives using the Jupyter ecosystem. It is also a core component of Jupyter Book.

Check out the Gallery of Jupyter Books, for inspiration from across the community.

See also, the MyST-Markdown VS Code extension and jupyterlab-myst, for editor tools to author your notebooks.