nbsphinx
Jupyter Notebook Tools for Sphinx
Decision gist · record as of 2026-08-14
Yes. nbsphinx is actively maintained, has low install friction, carries no security vulnerabilities, and solves a specific and well-defined problem: integrating Jupyter Notebooks into Sphinx documentation. Install it if you want to include executable notebooks or notebook-style examples in your Sphinx docs; skip it if your documentation doesn't use notebooks.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python >= 3.8 and an existing Sphinx documentation project.
- Low friction: pure Python wheel with six runtime dependencies.
- Actively maintained with a recent release (259 days ago) and steady commit activity.
License · maintenance · safety
MIT (permissive) — MIT license (permissive) places no restrictions on use, modification, or distribution in your own projects.
last release 2025-11-28 (259 days) · last repo commit 2026-07-21 · 472 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 1,913,540 downloads/mo, #3,438 on PyPI
Alternatives
Verify before relying
pip install nbsphinx
Edit conf.py and add 'nbsphinx' to extensions:
extensions = ['nbsphinx']
Add notebook filenames to index.rst toctree:
.. toctree::
my_notebook.ipynb- Whether automatic notebook execution during build requires specific Jupyter kernel or environment setup beyond the listed dependencies.
- Performance characteristics when building documentation with many or large notebooks.
What it is and what it does
nbsphinx bridges Jupyter Notebooks and Sphinx documentation by treating .ipynb files as native Sphinx source. When you add notebook filenames to your Sphinx toctree, the extension parses them, renders code cells and outputs as documentation, and automatically executes any notebooks that lack stored output. This lets you write executable examples or tutorials as Jupyter Notebooks and have them appear seamlessly in your Sphinx-built HTML or LaTeX docs.
The package depends on nbconvert and nbformat to handle notebook I/O, sphinx for the documentation framework, and supporting libraries (docutils, jinja2, traitlets) for rendering and configuration. It's designed for technical documentation, education, and research contexts where executable code examples are valuable.
Use it for
- Include executable Jupyter tutorials or walkthroughs directly in Sphinx documentation without manual conversion.
- Build API documentation that interleaves narrative text with runnable code examples from notebooks.
- Create scientific or research documentation where computed results are embedded in the final HTML or PDF output.
- Maintain a single notebook source that serves both as a standalone Jupyter file and as part of your Sphinx docs.
- Automatically regenerate documentation output from notebooks during the build, keeping examples in sync with code.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
nbsphinx is actively maintained, has low install friction, carries no security vulnerabilities, and solves a specific and well-defined problem: integrating Jupyter Notebooks into Sphinx documentation. Install it if you want to include executable notebooks or notebook-style examples in your Sphinx docs; skip it if your documentation doesn't use notebooks.
Install
nbsphinx on PyPI
Before you install
Low friction: pure Python wheel with six runtime dependencies. Actively maintained with a recent release (259 days ago) and steady commit activity.
Requires Python >= 3.8 and an existing Sphinx documentation project.
License in practice
MIT license (permissive) places no restrictions on use, modification, or distribution in your own projects.
Quickstart
pip install nbsphinx
Edit conf.py and add 'nbsphinx' to extensions:
extensions = ['nbsphinx']
Add notebook filenames to index.rst toctree:
.. toctree::
my_notebook.ipynbVerify before relying
- Whether automatic notebook execution during build requires specific Jupyter kernel or environment setup beyond the listed dependencies.
- Performance characteristics when building documentation with many or large notebooks.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.8 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 6 packagesdocutilsjinja2nbconvertnbformatsphinxtraitlets |
| Maintenance | Actively maintained 259 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 1,913,540 / month, #3,438 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Framework :: JupyterFramework :: SphinxFramework :: Sphinx :: ExtensionIntended Audience :: EducationIntended Audience :: Science/ResearchOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Topic :: Documentation :: Sphinx |
Evidence: nbsphinx-0.9.8-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 › “jupyter notebook sphinx documentation”
- nbsphinxnbsphinx is a Sphinx extension that parses Jupyter Notebook files…
- myst-nbSphinx extension that parses and converts Jupyter Notebooks (.ipynb…
- nbsphinx-linkA Sphinx extension that lets you include Jupyter notebooks from…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
See also myst-nb · nbsphinx-link · sphinx-jupyterbook-latex · nbdev · nbstripout · jupyter-sphinx · ipynbname · importnb · nbval · nbconvert