jupyter / jupyter-sphinx

Sphinx extension for rendering of Jupyter interactive widgets.
https://jupyter-sphinx.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
188 stars 65 forks source link
jupyter python sphinx-extension

Jupyter Sphinx Extensions

BSD licence black prettier pre-commit pypi version conda-forge version badge tests docs

jupyter-sphinx enables running code embedded in Sphinx documentation and embedding output of that code into the resulting document. It has support for rich output such as images and even Jupyter interactive widgets.

Installation

With pip:

pip install jupyter_sphinx

with conda:

conda install jupyter_sphinx -c conda-forge

Usage

You can check out the documentation on https://jupyter-sphinx.readthedocs.io for up to date usage information and examples.

License

We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.

All code is licensed under the terms of the revised BSD license.