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

Uploaded Source

Built Distribution

nbsphinx-0.4.1-py2.py3-none-any.whl (19.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.4.1.tar.gz
  • Upload date:
  • Size: 108.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2rc1

File hashes

Hashes for nbsphinx-0.4.1.tar.gz
Algorithm Hash digest
SHA256 f79bcb74b8ff700fa936eca76dd57f3aed8f3d5e3cbb5c441f546a647ada01b8
MD5 a540f67facad59e0ee10886b7320c15a
BLAKE2b-256 a40cf47af9940dff0705f60745b5c74ad1dd4861bbe2485d6b23c51ff0967e49

See more details on using hashes here.

File details

Details for the file nbsphinx-0.4.1-py2.py3-none-any.whl.

File metadata

  • Download URL: nbsphinx-0.4.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2rc1

File hashes

Hashes for nbsphinx-0.4.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 551256d804fe8137a75ea75d0c2dbb4f40b3af7fe4f10aafcdd992d46f4bf67a
MD5 a5ec69ddf18584b38bbaefb7b5dc6e38
BLAKE2b-256 ef034bda13a4ea13ac9fdf44e23f215b65e727285a7259cbb4e2ff8969e0a5a5

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