Skip to content

Commit 6d32cd8

Browse files
jtpiomartinRenou
andauthored
Update docs to mention adding other kernels (#94)
* Add kernel not in installation page * Update configuration page * Update docs/installation.md Co-authored-by: martinRenou <[email protected]> * try fixing backticks --------- Co-authored-by: martinRenou <[email protected]>
1 parent 6dd8135 commit 6d32cd8

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/configuration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ The `jupyterlite_config.json` containing the following:
4242
"LiteBuildConfig": {
4343
"federated_extensions": [
4444
"https://conda.anaconda.org/conda-forge/noarch/bqplot-0.12.33-pyhd8ed1ab_0.tar.bz2",
45+
"https://github.com/jupyterlite/pyodide-kernel/releases/download/v0.0.5/jupyterlite_pyodide_kernel-0.0.5-py3-none-any.whl"
4546
],
4647
"ignore_sys_prefix": true
4748
}
@@ -53,6 +54,9 @@ The `jupyterlite_config.json` containing the following:
5354
}
5455
```
5556

57+
The example above also includes the Pyodide kernel for JupyterLite as a `federated_extensions`.
58+
See the [JupyterLite documentation](https://jupyterlite.readthedocs.io/en/latest/howto/index.html) to learn more about configuring your environment.
59+
5660
Then you should be able to show Notebooks working with bqplot!
5761

5862
```rst

docs/installation.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,16 @@ extensions = [
1717
```
1818

1919
JupyterLite should automatically show up in your built online documentation. To preview it locally, you can navigate to the build directory (e.g. `_build/html`) and use `python -m http.server` to serve the site.
20+
21+
````{note}
22+
By default `jupyterlite-sphinx` does not install a Python kernel.
23+
If you would like have a Python kernel available in your docs you can install either `jupyterlite-pyodide-kernel` or `jupyterlite-xeus-python` with `pip`:
24+
25+
```shell
26+
# to install the Python kernel based on Pyodide
27+
pip install jupyterlite-pyodide-kernel
28+
29+
# to install the Python kernel based on Xeus Python
30+
pip install jupyterlite-xeus-python
31+
```
32+
````

0 commit comments

Comments
 (0)