Merge pull request #46 from danielballan/binder-overrides

bsipocz · web-flow · commit 7496e67fc064 · 2025-05-13T13:07:43.000-07:00
Binder integration
diff --git a/.binder/overrides.json b/.binder/overrides.json
diff --git a/.binder/postBuild b/.binder/postBuild
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -eux
+
+mkdir -p ${NB_PYTHON_PREFIX}/share/jupyter/lab/settings
+cp .binder/overrides.json ${NB_PYTHON_PREFIX}/share/jupyter/lab/settings/overrides.json
diff --git a/.binder/requirements.txt b/.binder/requirements.txt
@@ -0,0 +1 @@
+-r ../requirements.txt
diff --git a/conf.py b/conf.py
@@ -53,4 +53,7 @@
     "use_repository_button": True,
     "use_issues_button": True,
     "use_edit_page_button": True,
+    "launch_buttons": {
+        "binderhub_url": "https://mybinder.org"
+    },
 }
diff --git a/pixi.toml b/pixi.toml
@@ -26,7 +26,10 @@ start = "jupyter lab"
 test = "bash ./test.sh"
 
 [activation]
-scripts = ["setup_jupyterlab_config.sh"]
+# Workaround overrides JupyterLab configuration (at the environment level) to
+# make double-clicking on a Jupytext Markdown file open that file as a
+# notebook. This is important for the development workflow for contributors.
+scripts = ["bash .binder/postBuild"]
 
 [dependencies]
 python = ">=3.11"
diff --git a/requirements.txt b/requirements.txt
@@ -11,3 +11,4 @@ pytest
 nbval
 pytest-custom_exit_code
 jupytext
+jupyterlab-myst
diff --git a/setup_jupyterlab_config.sh b/setup_jupyterlab_config.sh

Original file line number	Diff line number	Diff line change
`@@ -53,4 +53,7 @@`
`53`	`53`	`"use_repository_button": True,`
`54`	`54`	`"use_issues_button": True,`
`55`	`55`	`"use_edit_page_button": True,`
	`56`	`+ "launch_buttons": {`
	`57`	`+ "binderhub_url": "https://mybinder.org"`
	`58`	`+ },`
`56`	`59`	`}`