Skip to content

Commit b982334

Browse files
authored
Update jupyter lite build command documentation (#343)
1 parent 703be7d commit b982334

File tree

3 files changed

+22
-1
lines changed

3 files changed

+22
-1
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,13 @@ To build Jupyter Lite with this kernel without creating a website you can execut
150150
micromamba create -n xeus-lite-host jupyterlite-core=0.6 jupyter_server jupyterlite-xeus -c conda-forge
151151
micromamba activate xeus-lite-host
152152
jupyter lite build --XeusAddon.prefix=$PREFIX
153+
--XeusAddon.mounts="$PREFIX/share/xeus-cpp/tagfiles:/share/xeus-cpp/tagfiles" \
154+
--XeusAddon.mounts="$PREFIX/etc/xeus-cpp/tags.d:/etc/xeus-cpp/tags.d" \
155+
--contents README.md \
156+
--contents notebooks/xeus-cpp-lite-demo.ipynb \
157+
--contents notebooks/smallpt.ipynb \
158+
--contents notebooks/images/marie.png \
159+
--contents notebooks/audio/audio.wav
153160
```
154161

155162
Once the Jupyter Lite site has built you can test the website locally by executing

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,14 @@ To build Jupyter Lite with this kernel without creating a website you can execut
151151
```bash
152152
micromamba create -n xeus-lite-host jupyterlite-core=0.6 jupyter_server jupyterlite-xeus -c conda-forge
153153
micromamba activate xeus-lite-host
154-
jupyter lite build --XeusAddon.prefix=$PREFIX
154+
jupyter lite build --XeusAddon.prefix=$PREFIX
155+
--XeusAddon.mounts="$PREFIX/share/xeus-cpp/tagfiles:/share/xeus-cpp/tagfiles" \
156+
--XeusAddon.mounts="$PREFIX/etc/xeus-cpp/tags.d:/etc/xeus-cpp/tags.d" \
157+
--contents README.md \
158+
--contents notebooks/xeus-cpp-lite-demo.ipynb \
159+
--contents notebooks/smallpt.ipynb \
160+
--contents notebooks/images/marie.png \
161+
--contents notebooks/audio/audio.wav
155162
```
156163

157164
Once the Jupyter Lite site has built you can test the website locally by executing

docs/source/InstallationAndUsage.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,13 @@ To build Jupyter Lite with this kernel without creating a website you can execut
133133
micromamba create -n xeus-lite-host jupyterlite-core=0.6 jupyter_server jupyterlite-xeus -c conda-forge
134134
micromamba activate xeus-lite-host
135135
jupyter lite build --XeusAddon.prefix=$PREFIX
136+
--XeusAddon.mounts="$PREFIX/share/xeus-cpp/tagfiles:/share/xeus-cpp/tagfiles" \
137+
--XeusAddon.mounts="$PREFIX/etc/xeus-cpp/tags.d:/etc/xeus-cpp/tags.d" \
138+
--contents README.md \
139+
--contents notebooks/xeus-cpp-lite-demo.ipynb \
140+
--contents notebooks/smallpt.ipynb \
141+
--contents notebooks/images/marie.png \
142+
--contents notebooks/audio/audio.wav
136143
137144
Once the Jupyter Lite site has built you can test the website locally by executing
138145

0 commit comments

Comments
 (0)