From 792699636c56b9205bc59a8cf7def7e574346792 Mon Sep 17 00:00:00 2001 From: Jeremy Tuloup Date: Fri, 23 Feb 2024 17:31:14 +0000 Subject: [PATCH] Update to `jupyterlite-xeus` --- dev-environment.yml | 4 ++-- docs/configuration.md | 6 +++--- docs/environment.yml | 3 ++- docs/installation.md | 6 +++--- pyproject.toml | 2 +- 5 files changed, 11 insertions(+), 10 deletions(-) diff --git a/dev-environment.yml b/dev-environment.yml index 41ef0af..2a52543 100644 --- a/dev-environment.yml +++ b/dev-environment.yml @@ -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 diff --git a/docs/configuration.md b/docs/configuration.md index 25f2b79..dd9b60e 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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. diff --git a/docs/environment.yml b/docs/environment.yml index 89addc8..c23b71a 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -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 diff --git a/docs/installation.md b/docs/installation.md index 1d3373e..13bd2ef 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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 ``` ```` \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index b65e0e6..74a3731 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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]