sphinx-exec-jupyter
This Sphinx extension allows you to execute Jupyter notebooks and include their output in your documentation.
Installation
Install or depend on sphinx-exec-jupyter,
optionally with the holoviews extra (see below).
Then enable this extension in your conf.py:
extensions = [
"sphinx_exec_jupyter",
]
Directives
exec-jupyter
Executes a Jupyter notebook cell and includes its output:
.. exec-jupyter::
import numpy as np
np.random.rand(4)
holoviews
Enable by installing the holoviews extra by depending on sphinx-exec-jupyter[holoviews]
Embeds a HoloViews plot:
.. holoviews::
:backends: bokeh,matplotlib
hv.Curve([1, 2, 3, 2, 1])
The default for backends is defined by a Sphinx conf.py setting:
holoviews_backends = ['bokeh']
For detailed documentation, visit Read the Docs.
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_exec_jupyter-0.4.0.tar.gz.
File metadata
- Download URL: sphinx_exec_jupyter-0.4.0.tar.gz
- Upload date:
- Size: 20.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ed81a650d6ba8fdb447e928e4a219fc287f2be896ce32b140088db789fafa3cb
|
|
| MD5 |
593e9e6d116924d86da6bbef9060624f
|
|
| BLAKE2b-256 |
fb93712a90b988c2fb5b0e15b7af2bed46d801d1ca24808ff191e198794ae323
|
Provenance
The following attestation bundles were made for sphinx_exec_jupyter-0.4.0.tar.gz:
Publisher:
release.yml on flying-sheep/sphinx-exec-jupyter
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_exec_jupyter-0.4.0.tar.gz -
Subject digest:
ed81a650d6ba8fdb447e928e4a219fc287f2be896ce32b140088db789fafa3cb - Sigstore transparency entry: 2126580466
- Sigstore integration time:
-
Permalink:
flying-sheep/sphinx-exec-jupyter@100e6c6bdbea2d1cdf068878ec894c246618a95c -
Branch / Tag:
refs/tags/v0.4.0 - Owner: https://github.com/flying-sheep
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@100e6c6bdbea2d1cdf068878ec894c246618a95c -
Trigger Event:
release
-
Statement type:
File details
Details for the file sphinx_exec_jupyter-0.4.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_exec_jupyter-0.4.0-py3-none-any.whl
- Upload date:
- Size: 17.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
896d328bcc915532da962fe03c9e47a3f1348f029ad2ccffe6e4629506c3a346
|
|
| MD5 |
6ace9d87b619a7d07782c1bb6dcf8def
|
|
| BLAKE2b-256 |
b292b4672810d46666be42fb0b99521bdb19bbd630a0a284219b33ed2a7238f8
|
Provenance
The following attestation bundles were made for sphinx_exec_jupyter-0.4.0-py3-none-any.whl:
Publisher:
release.yml on flying-sheep/sphinx-exec-jupyter
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_exec_jupyter-0.4.0-py3-none-any.whl -
Subject digest:
896d328bcc915532da962fe03c9e47a3f1348f029ad2ccffe6e4629506c3a346 - Sigstore transparency entry: 2126580771
- Sigstore integration time:
-
Permalink:
flying-sheep/sphinx-exec-jupyter@100e6c6bdbea2d1cdf068878ec894c246618a95c -
Branch / Tag:
refs/tags/v0.4.0 - Owner: https://github.com/flying-sheep
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@100e6c6bdbea2d1cdf068878ec894c246618a95c -
Trigger Event:
release
-
Statement type:
