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.
- Documentation (and example of use):
- Code:
- Python Package Index:
- License:
MIT – see the file LICENSE for details.
- Quick Start:
Install nbsphinx with pip:
pip install nbsphinx --user
Edit your conf.py and add 'nbsphinx' to extensions.
Edit your index.rst and add the names of your *.ipynb files (without the .ipynb extension) to the toctree directive.
Run Sphinx!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file nbsphinx-0.2.3.tar.gz
.
File metadata
- Download URL: nbsphinx-0.2.3.tar.gz
- Upload date:
- Size: 33.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea3d2ee8f8b9d72247dd59a302c0096cfef9313ae2f35881f96be0a543e16fee |
|
MD5 | e6dde171547187850ee7d5b328c1f1e2 |
|
BLAKE2b-256 | 6ee9486383e248d77cc31fd8263a997a13651f70086d2c56b1027059eeb56502 |
File details
Details for the file nbsphinx-0.2.3-py2.py3-none-any.whl
.
File metadata
- Download URL: nbsphinx-0.2.3-py2.py3-none-any.whl
- Upload date:
- Size: 30.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5c9387a6222393e991ddc2ba204fbd2a65b785e20ac0bfb1e58f34aed806f20 |
|
MD5 | 37ef6a3ee9a5b909b4e28c0dcd83717b |
|
BLAKE2b-256 | 5ae1a81d678a18ddb6e1571c9155c7160bd3bcba1ee12d9605a1cf942972880b |