nbsphinx 0.9.7


pip install nbsphinx

  Latest version

Released: Mar 03, 2025
Navigation
Meta
Author: Matthias Geier
Requires Python: >=3.6
Classifiers

Framework
  • Sphinx
  • Sphinx :: Extension
  • Jupyter

Intended Audience
  • Education
  • Science/Research

License
  • OSI Approved :: MIT License

Operating System
  • OS Independent

Programming Language
  • Python
  • Python :: 3

Topic
  • Documentation :: 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:

  1. Install nbsphinx

  2. Edit your conf.py and add 'nbsphinx' to extensions.

  3. Edit your index.rst and add the names of your *.ipynb files to the toctree.

  4. 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.

0.9.7 Mar 03, 2025
0.9.6 Dec 24, 2024
0.9.5 Aug 13, 2024
0.9.4 May 06, 2024
0.9.3 Aug 27, 2023
0.9.2 May 24, 2023
0.9.1 Mar 14, 2023
0.9.0 Mar 12, 2023
0.8.12 Jan 19, 2023
0.8.11 Dec 29, 2022
0.8.10 Nov 13, 2022
0.8.9 Jun 04, 2022
0.8.8 Dec 31, 2021
0.8.7 Aug 10, 2021
0.8.6 Jun 03, 2021
0.8.5 May 12, 2021
0.8.4 Apr 29, 2021
0.8.3 Apr 09, 2021
0.8.2 Feb 28, 2021
0.8.1 Jan 18, 2021
0.8.0 Oct 20, 2020
0.7.1 Jun 16, 2020
0.7.0 May 08, 2020
0.6.1 Apr 18, 2020
0.6.0 Apr 03, 2020
0.5.1 Jan 28, 2020
0.5.0 Nov 20, 2019
0.4.3 Sep 30, 2019
0.4.2 Jan 15, 2019
0.4.1 Dec 16, 2018
0.4.0 Dec 14, 2018
0.3.5 Sep 10, 2018
0.3.4 Jul 28, 2018
0.3.3 Apr 25, 2018
0.3.2 Mar 28, 2018
0.3.1 Jan 17, 2018
0.3.0 Jan 02, 2018
0.2.18 Dec 03, 2017
0.2.17 Nov 12, 2017
0.2.16 Nov 07, 2017
0.2.15 Nov 03, 2017
0.2.14 Jun 09, 2017
0.2.13 Jan 25, 2017
0.2.12 Dec 19, 2016
0.2.11 Nov 19, 2016
0.2.10 Oct 16, 2016
0.2.9 Jul 26, 2016
0.2.8 May 20, 2016
0.2.7 May 04, 2016
0.2.6 Apr 12, 2016
0.2.5 Mar 15, 2016
0.2.4 Feb 12, 2016
0.2.3 Jan 22, 2016
0.2.2 Jan 06, 2016
0.2.1 Jan 04, 2016
0.2.0 Dec 27, 2015

Wheel compatibility matrix

Platform Python 3
any

Files in release

Extras: None
Dependencies:
docutils (>=0.18.1)
jinja2
nbconvert (!=5.4,>=5.3)
traitlets (>=5)
nbformat
sphinx (<8.2,>=1.8)