From 09452ca5ebaf0fc07679b1a965e52bcd75d3fcbb Mon Sep 17 00:00:00 2001 From: Zac Warham <48937711+ZacWarham@users.noreply.github.com> Date: Tue, 14 Jan 2025 12:16:14 -0800 Subject: [PATCH] Launch file documentation for jupyterlab-python (#11162) * Launch file instructions * Small formatting tweaks * Update workspaces/jupyterlab-python/README.md Co-authored-by: Nathan Sarang-Walters --------- Co-authored-by: Nathan Sarang-Walters --- workspaces/jupyterlab-python/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 workspaces/jupyterlab-python/README.md diff --git a/workspaces/jupyterlab-python/README.md b/workspaces/jupyterlab-python/README.md new file mode 100644 index 00000000000..da4ea869f78 --- /dev/null +++ b/workspaces/jupyterlab-python/README.md @@ -0,0 +1,16 @@ +# workspace-jupyterlab-python + +To automatically open a file when the workspace is started, set the `LAUNCH_FILE_NAME` environment variable in your question's `info.json`: + +```json +{ + "workspaceOptions": { + "image": "prairielearn/workspace-jupyterlab-python", + "environment": { + "LAUNCH_FILE_NAME": "some_file.ext" + } + } +} +``` + +Replace `some_file.ext` with your file. It is expected that this file exists inside of the `/workspace` directory of the question. See the [workspaces documentation](https://prairielearn.readthedocs.io/en/latest/workspaces/) for more details on environment variable usage.