Skip to content
This repository has been archived by the owner on Feb 14, 2024. It is now read-only.

Commit

Permalink
Add documentation for installing local pip packages (#146)
Browse files Browse the repository at this point in the history
  • Loading branch information
martinRenou committed Aug 3, 2023
1 parent 13dc529 commit caa4193
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions docs/configuration.md
Expand Up @@ -10,7 +10,7 @@ Furthermore, this automatically installs any labextension that it founds, for ex

Say you want to install `NumPy`, `Matplotlib` and `ipycanvas`, it can be done by creating the `environment.yml` file with the following content:

```
```yaml
name: xeus-python-kernel
channels:
- https://repo.mamba.pm/emscripten-forge
Expand Down Expand Up @@ -68,7 +68,7 @@ There are a couple of limitations that you should be aware of:

For example, if you were to install `ipycanvas` from PyPI, you would need to install the ipycanvas dependencies for it to work (`pillow`, `numpy` and `ipywidgets`):

```
```yaml
name: xeus-python-kernel
channels:
- https://repo.mamba.pm/emscripten-forge
Expand All @@ -81,6 +81,19 @@ dependencies:
- ipycanvas
```

You can also install a local Python package, this is very practical if you want to embed
a jupyterlite deployment in your Package documentation, allowing to test the very latest dev version:

```yaml
name: xeus-python-kernel
channels:
- https://repo.mamba.pm/emscripten-forge
- https://repo.mamba.pm/conda-forge
dependencies:
- pip:
- ..
```

## Advanced Configuration

```{warning}
Expand Down

0 comments on commit caa4193

Please sign in to comment.