https://github.com/jupyter/jupyter-sphinx

Sphinx extension for rendering of Jupyter interactive widgets.
https://github.com/jupyter/jupyter-sphinx

jupyter python sphinx-extension

Last synced: 27 days ago
JSON representation

Sphinx extension for rendering of Jupyter interactive widgets.

• Host: GitHub
• URL: https://github.com/jupyter/jupyter-sphinx
• Owner: jupyter
• License: bsd-3-clause
• Created: 2016-11-15T18:36:37.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-09-23T02:54:02.000Z (about 1 month ago)
• Last Synced: 2024-09-30T05:29:30.597Z (about 1 month ago)
• Topics: jupyter, python, sphinx-extension
• Language: Python
• Homepage: https://jupyter-sphinx.readthedocs.io/
• Size: 793 KB
• Stars: 186
• Watchers: 23
• Forks: 65
• Open Issues: 51
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-jupyter-resources - GitHub - 33% open · ⏱️ 25.06.2022): (Jupyter-Notebook工具)
• best-of-jupyter - GitHub - 30% open · ⏱️ 17.06.2024): (Notebook Tools)

README

        
# Jupyter Sphinx Extensions

[![BSD licence](https://img.shields.io/badge/License-BSD3-yellow.svg?logo=opensourceinitiative&logoColor=white)](LICENSE)

[![black](https://img.shields.io/badge/code%20style-black-000000)](https://github.com/psf/black)

[![prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?logo=prettier&logoColor=white)](https://github.com/prettier/prettier)

[![pre-commit](https://img.shields.io/badge/pre--commit-active-yellow?logo=pre-commit&logoColor=white)](https://pre-commit.com/)

[![pypi version](https://img.shields.io/pypi/v/jupyter-sphinx?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/jupyter-sphinx/)

[![conda-forge version badge](https://img.shields.io/conda/vn/conda-forge/jupyter-sphinx?logo=anaconda&logoColor=white&color=blue)](https://anaconda.org/conda-forge/jupyter-sphinx)

[![tests](https://img.shields.io/github/actions/workflow/status/jupyter/jupyter-sphinx/tests.yml?logo=github&logoColor=white)](https://github.com/jupyter/jupyter-sphinx/actions/workflows/tests.yml)

[![docs](https://img.shields.io/readthedocs/jupyter-sphinx?logo=readthedocs&logoColor=white)](https://jupyter-sphinx.readthedocs.io/)

`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:

```bash

pip install jupyter_sphinx

```

with conda:

```bash

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.