1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
# sphinx-thebe
```{image} https://readthedocs.org/projects/sphinx-thebe/badge/?version=latest
:target: https://sphinx-thebe.readthedocs.io/en/latest/?badge=latest
:alt: Documentation
```
```{image} https://img.shields.io/pypi/v/sphinx-thebe.svg
:target: https://pypi.org/project/sphinx_thebe
:alt: PyPi page
```
Make your code cells interactive with a kernel provided by [Thebe](http://thebe.readthedocs.org/) and [Binder](https://mybinder.org).
It uses the excellent [thebe project](http://thebe.readthedocs.org/), and pre-configures `thebe` to be compatible with common Jupyter-related patterns in the Sphinx ecosystem, such as [MyST-NB](https://myst-nb.readthedocs.io/).
For example, click the button below. Notice that the code block beneath becomes
editable and runnable!
```{thebe-button} Launch thebe
```
```{code-block} python
:class: thebe
print("hi")
```
See [](use.md) for more information about what you can do with `sphinx-thebe`.
## Install
To install `sphinx-thebe` first clone and install it:
```
pip install sphinx-thebe
```
Then, add it to your Sphinx site's `conf.py` file:
```
extensions = [
...
"sphinx_thebe"
...
]
```
## Configure and use
For more information about how to configure `sphinx-thebe`, see [](configure.md).
For more information on using `sphinx-thebe`, see [](use.md).
```{toctree}
:hidden:
use
configure
examples/notebooks
contribute
changelog
```
|
