Automatically setup a jupyter kernel for your documentation build
Project description
sphinx-jupyter-kernel
sphinx-jupyter-kernel is a lightweight Sphinx extension that automates the creation and management of temporary Jupyter kernels during documentation builds. This ensures reproducible execution of notebooks (e.g., via MyST-NB) without polluting your global Jupyter environment.
Installation
Install via pip:
pip install sphinx-jupyter-kernel
Quick Setup
Add to your conf.py (place before myst_nb in extensions for proper aliasing):
extensions = [
'sphinx_jupyter_kernel', # Must come before myst_nb
# ... other extensions
'myst_nb', # Or nbsphinx, etc.
]
# Set your desired kernel name (must match notebooks' metadata)
kernel_name = 'my-custom-kernel'
License
MIT License—see LICENSE for 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
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_jupyter_kernel-0.1.0.tar.gz.
File metadata
- Download URL: sphinx_jupyter_kernel-0.1.0.tar.gz
- Upload date:
- Size: 56.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.10 {"installer":{"name":"uv","version":"0.9.10"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
806a358f0aed5196cc0de607a9564e6518a3942ea7b5d332792819c73c08601c
|
|
| MD5 |
0ea2929e732613d7cb75b20448d11920
|
|
| BLAKE2b-256 |
604b44481fd60bfbe826625a922ace89c536f0df9270a5d933f5ea3eb7a8aea6
|
File details
Details for the file sphinx_jupyter_kernel-0.1.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_jupyter_kernel-0.1.0-py3-none-any.whl
- Upload date:
- Size: 3.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.10 {"installer":{"name":"uv","version":"0.9.10"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b0f4ccbbafded76b9e85c93ff083d9cc8b68fe03985fa68a3586b5d74a7917d2
|
|
| MD5 |
3eced4e12841b74497ccdbb062eead9c
|
|
| BLAKE2b-256 |
176f84f8c5984cb792ef9847c63f72ee7daa3a7b80b419c2102983c6d6c54d9a
|
