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
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.