myst-nb
A Jupyter Notebook Sphinx reader built on top of the MyST markdown parser.
Decision gist · record as of 2026-08-14
Yes, if you use Sphinx for documentation and want to include Jupyter Notebooks without manual conversion. The install friction is low, maintenance is active, and the package is in the top 5000 by downloads. The only caveat is that the license status is unclear in the metadata—verify the actual license in the repository before using in proprietary contexts. No known security vulnerabilities.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later.
- Sphinx and IPython must be installed and configured.
- Low friction install with a pure Python wheel.
License · maintenance · safety
(unclear) — License status is unclear from the package metadata—no SPDX identifier or raw license field is recorded. Verify the actual license in the repository before adopting in proprietary or restricted-license contexts.
last release 2026-03-02 (165 days) · last repo commit 2026-08-03 · 238 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 1,052,857 downloads/mo, #4,438 on PyPI
Alternatives
Verify before relying
pip install myst-nb
# In conf.py:
extensions = ['myst_nb']
# Then add .ipynb files to your Sphinx source tree and build normally.- Actual license text and terms—metadata shows no SPDX or raw license field despite active development.
- Whether notebook execution is automatic or opt-in during documentation builds.
- Performance characteristics with large notebooks or many notebooks in a single build.
What it is and what it does
MyST-NB is a Sphinx extension that lets you write and include Jupyter Notebooks directly in Sphinx documentation builds. Instead of converting notebooks to Markdown or reStructuredText by hand, you drop .ipynb files into your source tree and Sphinx reads them natively, rendering cells, outputs, and markdown content as part of your docs. It builds on the MyST parser, which understands Markdown syntax, so your notebooks can use MyST-flavored Markdown alongside standard Jupyter cell syntax.
The package sits at the intersection of Jupyter and Sphinx tooling. It depends on IPython, nbclient, jupyter-cache, and nbformat to handle notebook parsing and execution, plus Sphinx itself for documentation generation. It's actively maintained, supports Python 3.10 through 3.14, and is used in production documentation workflows. The main constraint is that you need a working Sphinx setup and familiarity with how Sphinx extensions are configured.
Use it for
- Build technical documentation that includes executable Jupyter notebooks as chapters or sections.
- Publish data science or research notebooks as part of a larger Sphinx documentation site.
- Create tutorials or guides where notebook cells and their outputs are rendered inline in the final docs.
- Maintain a single source (the notebook) that serves both as an interactive tool and as documentation.
- Integrate notebooks into ReadTheDocs or similar CI/CD-driven documentation builds.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you use Sphinx for documentation and want to include Jupyter Notebooks without manual conversion.
The install friction is low, maintenance is active, and the package is in the top 5000 by downloads. The only caveat is that the license status is unclear in the metadata—verify the actual license in the repository before using in proprietary contexts. No known security vulnerabilities.
Install
myst-nb on PyPI
Before you install
Low friction install with a pure Python wheel. Actively maintained as of August 2026 with recent commits. Depends on a substantial stack (Sphinx, IPython, nbclient, jupyter-cache, myst-parser) but all are standard ecosystem packages.
Requires Python 3.10 or later. Sphinx and IPython must be installed and configured.
License in practice
License status is unclear from the package metadata—no SPDX identifier or raw license field is recorded. Verify the actual license in the repository before adopting in proprietary or restricted-license contexts.
Quickstart
pip install myst-nb
# In conf.py:
extensions = ['myst_nb']
# Then add .ipynb files to your Sphinx source tree and build normally.Verify before relying
- Actual license text and terms—metadata shows no SPDX or raw license field despite active development.
- Whether notebook execution is automatic or opt-in during documentation builds.
- Performance characteristics with large notebooks or many notebooks in a single build.
Package facts
| License | Not declared unclear |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 10 packagesimportlib_metadataipythonjupyter-cachenbclientmyst-parsernbformatpyyamlsphinxtyping-extensionsipykernel |
| Maintenance | Actively maintained 165 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 1,052,857 / month, #4,438 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: Implementation :: CPythonProgramming Language :: Python :: Implementation :: PyPyTopic :: Software Development :: Libraries :: Python ModulesTopic :: Text Processing :: Markup |
Evidence: myst_nb-1.4.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “convert ipynb to sphinx docs”
- myst-nbSphinx extension that parses and converts Jupyter Notebooks (.ipynb…
- nbsphinxnbsphinx is a Sphinx extension that parses Jupyter Notebook files…
- sphinxcontrib-confluencebuilderSphinx extension that converts reStructuredText documentation into…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also myst-parser · nbsphinx · nbsphinx-link · nbconvert · jupyter-book · importnb · jupyter-sphinx · hepconvert · mkdocs-jupyter · nbformat