nbsphinx

Jupyter Notebook Tools for Sphinx

58 个版本 Python >=3.8
Documentation
Issues
Repository
安装
pip install nbsphinx
poetry add nbsphinx
pipenv install nbsphinx
conda install nbsphinx
描述

Jupyter Notebook Tools for Sphinx

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/

分类
Framework :: Jupyter Framework :: Sphinx Framework :: Sphinx :: Extension Intended Audience :: Education Intended Audience :: Science/Research Operating System :: OS Independent Programming Language :: Python Programming Language :: Python :: 3 Topic :: Documentation :: Sphinx
版本列表
0.9.8 2025-11-28
0.9.7 2025-03-03
0.9.6 2024-12-24
0.9.5 2024-08-13
0.9.4 2024-05-06
0.9.3 2023-08-27
0.9.2 2023-05-24
0.9.1 2023-03-14
0.9.0 2023-03-12
0.8.12 2023-01-19
0.8.11 2022-12-29
0.8.10 2022-11-13
0.8.9 2022-06-04
0.8.8 2021-12-31
0.8.7 2021-08-10
0.8.6 2021-06-03
0.8.5 2021-05-12
0.8.4 2021-04-29
0.8.3 2021-04-09
0.8.2 2021-02-28
0.8.1 2021-01-18
0.8.0 2020-10-20
0.7.1 2020-06-16
0.7.0 2020-05-08
0.6.1 2020-04-18
0.6.0 2020-04-03
0.5.1 2020-01-28
0.5.0 2019-11-20
0.4.3 2019-09-30
0.4.2 2019-01-15
0.4.1 2018-12-16
0.4.0 2018-12-14
0.3.5 2018-09-10
0.3.4 2018-07-28
0.3.3 2018-04-25
0.3.2 2018-03-28
0.3.1 2018-01-17
0.3.0 2018-01-02
0.2.18 2017-12-03
0.2.17 2017-11-12
0.2.16 2017-11-07
0.2.15 2017-11-03
0.2.14 2017-06-09
0.2.13 2017-01-25
0.2.12 2016-12-19
0.2.11 2016-11-19
0.2.10 2016-10-16
0.2.9 2016-07-26
0.2.8 2016-05-20
0.2.7 2016-05-04
0.2.6 2016-04-12
0.2.5 2016-03-15
0.2.4 2016-02-12
0.2.3 2016-01-22
0.2.2 2016-01-06
0.2.1 2016-01-04
0.2.0 2015-12-27
0.0.0