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):

http://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.8.3.tar.gz (135.3 kB view details)

Uploaded Source

Built Distribution

nbsphinx-0.8.3-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.8.3.tar.gz
  • Upload date:
  • Size: 135.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.2

File hashes

Hashes for nbsphinx-0.8.3.tar.gz
Algorithm Hash digest
SHA256 447a46ec648fbadf9b389971869efb7f62b5a2498fa71f4f4279be18ceb86365
MD5 7b25b8268efc0de232c1557f9c9561a7
BLAKE2b-256 02ff8963ce848a5bd39fcb7677ca39906794085abb9c53fa353bd637fee87712

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsphinx-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 24.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.2

File hashes

Hashes for nbsphinx-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2f511896259c8d0a8f479be9a32add8d01bcc7bbf9176aa18ce80a6324394a89
MD5 24457e8c98b6dd80e259934ca46ba206
BLAKE2b-256 2d32034308aca1058374f83701d0ff0a16cdcf17adbde000db9e1bf07df2e929

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