Skip to content

Commit

Permalink
Update to jupyterlite-xeus
Browse files Browse the repository at this point in the history
  • Loading branch information
jtpio committed Feb 23, 2024
1 parent a744e0d commit 7926996
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 deletions.
4 changes: 2 additions & 2 deletions dev-environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ dependencies:
- pip
- jupyter_server
- jupyterlab_server
- jupyterlite-xeus-python >=0.9.7,<0.10.0
- jupyterlite-xeus >=0.1.8,<0.2..0
- jupyterlite-core >=0.2,<0.3
- pydata-sphinx-theme
- myst-parser
- docutils
- sphinx
- black
- voici
- pip:
- .
- voici
6 changes: 3 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ jupyterlite_dir = "/path/to/your/lite/dir"

## Pre-installed packages

In order to have Python packages pre-installed in the kernel environment, you can use [jupyterlite-xeus-python](https://xeus-python-kernel.readthedocs.io).
In order to have Python packages pre-installed in the kernel environment, you can use [jupyterlite-xeus](https://jupyterlite-xeus.readthedocs.io), with the `xeus-python` kernel.

You would need `jupyterlite-xeus-python` installed in your docs build environment.
You would need `jupyterlite-xeus` installed in your docs build environment.

You can pre-install packages by adding an `environment.yml` file in the docs directory, this file will be found automatically by xeus-python which will pre-build the environment when running the jupyter lite build.
You can pre-install packages by adding an `environment.yml` file in the docs directory, with `xeus-python` defined as one of the dependencies. It will pre-build the environment when running the `jupyter lite build`.

Furthermore, this automatically installs any labextension that it founds, for example installing ipyleaflet will make ipyleaflet work without the need to manually install the jupyter-leaflet labextension.

Expand Down
3 changes: 2 additions & 1 deletion docs/environment.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
name: jupyterlite-sphinx
channels:
- https://repo.mamba.pm/emscripten-forge
- https://repo.mamba.pm/conda-forge
- conda-forge
dependencies:
- pandas
- matplotlib
- bqplot
- xeus-python
6 changes: 3 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ JupyterLite should automatically show up in your built online documentation. To

````{note}
By default `jupyterlite-sphinx` does not install a Python kernel.
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`:
If you would like have a Python kernel available in your docs you can install either `jupyterlite-pyodide-kernel` or `jupyterlite-xeus` with `pip`:
```shell
# to install the Python kernel based on Pyodide
pip install jupyterlite-pyodide-kernel
# to install the Python kernel based on Xeus Python
pip install jupyterlite-xeus-python
# to load Xeus-based kernels
pip install jupyterlite-xeus
```
````
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ dev = [
docs = [
"myst_parser",
"pydata-sphinx-theme",
"jupyterlite-xeus-python>=0.9.0,<0.10.0",
"jupyterlite-xeus>=0.1.8,<0.2.0",
]

[tool.hatch.version]
Expand Down

0 comments on commit 7926996

Please sign in to comment.