nbsphinx is a Sphinx_ extension that provides a source parser for
*.ipynb files.
Custom Sphinx directives are used to show Jupyter Notebook_ code cells (and of
course their results) in both HTML and LaTeX output.
Un-evaluated notebooks -- i.e. notebooks without stored output cells -- will be
automatically executed during the Sphinx build process.
Quick Start:
#. Install nbsphinx
#. Edit your ``conf.py`` and add ``'nbsphinx'`` to ``extensions``.
#. Edit your ``index.rst`` and add the names of your ``*.ipynb`` files
to the ``toctree``.
#. Run Sphinx!
Online documentation (and example of use): https://nbsphinx.readthedocs.io/
Source code repository (and issue tracker): https://github.com/spatialaudio/nbsphinx/
License:
MIT -- see the file LICENSE for details.
.. _Sphinx: https://www.sphinx-doc.org/ .. _Jupyter Notebook: https://jupyter.org/
FAQs
Jupyter Notebook Tools for Sphinx
We found that nbsphinx demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The official Go SDK for the Model Context Protocol is in development, with a stable, production-ready release expected by August 2025.
Security News
New research reveals that LLMs often fake understanding, passing benchmarks but failing to apply concepts or stay internally consistent.
Security News
Django has updated its security policies to reject AI-generated vulnerability reports that include fabricated or unverifiable content.