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

Uploaded Source

Built Distribution

nbsphinx-0.8.2-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.8.2.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.1+

File hashes

Hashes for nbsphinx-0.8.2.tar.gz
Algorithm Hash digest
SHA256 53352237e2363079f6e38637a8ce90b47e720c8e2eb133a6a6f66fc13ff494cb
MD5 b74cc9804b1dd7ef497b5903a180a6cd
BLAKE2b-256 d6c2de7b81c165b517f59dc1f433cd667418b0e6a827d4e1de6af928f0e316b4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsphinx-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 24.4 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.1+

File hashes

Hashes for nbsphinx-0.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 044c5a8b13a03492372954940e99dedfaec206bd0be0faefb0e381c9f4435ac6
MD5 95c84b8b4b07f74371883ecbf58c36e7
BLAKE2b-256 cb9a3cf800179121da13d95cce3aa617d667d5f2983f87d0ab695ceed6d5ef78

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