Skip to main content

Jupyter Notebook Tools for Sphinx

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nbsphinx-0.9.2.tar.gz (171.8 kB view details)

Uploaded Source

Built Distribution

nbsphinx-0.9.2-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

Details for the file nbsphinx-0.9.2.tar.gz.

File metadata

  • Download URL: nbsphinx-0.9.2.tar.gz
  • Upload date:
  • Size: 171.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for nbsphinx-0.9.2.tar.gz
Algorithm Hash digest
SHA256 540db7f4066347f23d0650c4ae8e7d85334c69adf749e030af64c12e996ff88e
MD5 aa8bd70f8539fb71b4a4dfac5f937a60
BLAKE2b-256 fe6b07c6a160493e5edeedfa19fe6f665925fe0a4ba55e030865435ebce31252

See more details on using hashes here.

File details

Details for the file nbsphinx-0.9.2-py3-none-any.whl.

File metadata

  • Download URL: nbsphinx-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 31.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for nbsphinx-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2746680ece5ad3b0e980639d717a5041a1c1aafb416846b72dfaeecc306bc351
MD5 40de089d9ac79f4a1431005c8a59989b
BLAKE2b-256 9f30ee4dc91710a76c287128f205087544e8adb3a373959e70be6c555ddb40c2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page