semvec/pypi-packages huggingface dataset:
sphinx-jupyter-kernel 0.1.0
Automatically setup a jupyter kernel for your documentation build
Requires Python: >=3.10

# sphinx-jupyter-kernel

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**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:
```bash
pip install sphinx-jupyter-kernel
```
## Quick Setup
Add to your `conf.py` (place **before** `myst_nb` in `extensions` for proper aliasing):

```python
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](LICENSE) for details.