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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.8.0.tar.gz
  • Upload date:
  • Size: 131.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.6

File hashes

Hashes for nbsphinx-0.8.0.tar.gz
Algorithm Hash digest
SHA256 369c16fe93af14c878d61fb3e81d838196fb35b27deade2cd7b95efe1fe56ea0
MD5 48a73a205b96981ab5e8f9ae86891291
BLAKE2b-256 0dd0f0de27593cafa05bb42f92c171ea87ff5c040cb33c79b8d1711d18ffabde

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsphinx-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 24.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.6

File hashes

Hashes for nbsphinx-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 14ccbbd3d5944fd7e14087f67b83ea75cd41c9eb679561258237987d322e9381
MD5 4705b3dde53d57439abacd25c69e1ed5
BLAKE2b-256 6f7a9828e8981e472e717f695da957f52b389e91086532797005999342f487b5

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