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

Commit caa4193

Browse files
authored
Add documentation for installing local pip packages (#146)
1 parent 13dc529 commit caa4193

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

docs/configuration.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Furthermore, this automatically installs any labextension that it founds, for ex
1010

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

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

6969
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`):
7070

71-
```
71+
```yaml
7272
name: xeus-python-kernel
7373
channels:
7474
- https://repo.mamba.pm/emscripten-forge
@@ -81,6 +81,19 @@ dependencies:
8181
- ipycanvas
8282
```
8383
84+
You can also install a local Python package, this is very practical if you want to embed
85+
a jupyterlite deployment in your Package documentation, allowing to test the very latest dev version:
86+
87+
```yaml
88+
name: xeus-python-kernel
89+
channels:
90+
- https://repo.mamba.pm/emscripten-forge
91+
- https://repo.mamba.pm/conda-forge
92+
dependencies:
93+
- pip:
94+
- ..
95+
```
96+
8497
## Advanced Configuration
8598
8699
```{warning}

0 commit comments

Comments
 (0)