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.8.tar.gz (417.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nbsphinx-0.9.8-py3-none-any.whl (32.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.9.8.tar.gz
  • Upload date:
  • Size: 417.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nbsphinx-0.9.8.tar.gz
Algorithm Hash digest
SHA256 d0765908399a8ee2b57be7ae881cf2ea58d66db3af7bbf33e6eb48f83bea5495
MD5 990730352ce894321113be9f2de9e003
BLAKE2b-256 e7d182081750f8a78ad0399c6ed831d42623b891904e8e7b8a75878225cf1dce

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbsphinx-0.9.8.tar.gz:

Publisher: publish.yml on spatialaudio/nbsphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: nbsphinx-0.9.8-py3-none-any.whl
  • Upload date:
  • Size: 32.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nbsphinx-0.9.8-py3-none-any.whl
Algorithm Hash digest
SHA256 92d95ee91784e56bc633b60b767a6b6f23a0445f891e24641ce3c3f004759ccf
MD5 04b612a1c3ef04ed06d13efcc7341362
BLAKE2b-256 0378843bcf0cf31f88d2f8a9a063d2d80817b1901657d83d65b89b3aa835732e

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbsphinx-0.9.8-py3-none-any.whl:

Publisher: publish.yml on spatialaudio/nbsphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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