Update height configuration

Author: steppi

jupyterlite_sphinx/jupyterlite_sphinx.js

@@ -43,11 +43,12 @@ window.jupyterliteConcatSearchParams = (iframeSrc, params) => {
 
 window.tryExamplesShowIframe = (
     examplesContainerId, iframeContainerId, iframeParentContainerId, iframeSrc,
-    iframeMinHeight
+    iframeHeight
 ) => {
     const examplesContainer = document.getElementById(examplesContainerId);
     const iframeParentContainer = document.getElementById(iframeParentContainerId);
     const iframeContainer = document.getElementById(iframeContainerId);
+    var height;
 
     let iframe = iframeContainer.querySelector('iframe.jupyterlite_sphinx_raw_iframe');
 
@@ -56,8 +57,11 @@ window.tryExamplesShowIframe = (
               iframe = document.createElement('iframe');
               iframe.src = iframeSrc;
               iframe.style.width = '100%';
-              minHeight = parseInt(iframeMinHeight);
-              height = Math.max(minHeight, examples.offsetHeight);
+              if (iframeHeight !== 'None') {
+                  height = parseInt(iframeHeight);
+              } else {
+                  height = Math.max(tryExamplesGlobalMinHeight, examples.offsetHeight);
+              }
               iframe.style.height = `${height}px`;
               iframe.classList.add('jupyterlite_sphinx_raw_iframe');
               examplesContainer.classList.add("hidden");
@@ -78,6 +82,10 @@ window.tryExamplesHideIframe = (examplesContainerId, iframeParentContainerId) =>
 }
 
 
+/* Global variable for try_examples iframe minHeight. Defaults to 0 but can be
+ * modified based on configuration in try_examples.json */
+var tryExamplesGlobalMinHeight = 0;
+
 window.loadTryExamplesConfig = async (configFilePath) => {
     try {
         // Add a timestamp as query parameter to ensure a cached version of the
@@ -90,7 +98,7 @@ window.loadTryExamplesConfig = async (configFilePath) => {
         if (!response.ok) {
             if (response.status === 404) {
                 // Try examples ignore file is not present.
-                console.log('try_examples config file not found.');
+                console.log('Optional try_examples config file not found.');
                 return;
             }
             throw new Error(`Error fetching ${configFilePath}`);
@@ -101,6 +109,11 @@ window.loadTryExamplesConfig = async (configFilePath) => {
             return;
         }
 
+        // Set minimum iframe height based on value in config file
+        if (data.global_min_height) {
+            tryExamplesGlobalMinHeight = parseInt(data.global_min_height);
+        }
+
         // Disable interactive examples if file matches one of the ignore patterns
         // by hiding try_examples_buttons.
         Patterns = data.ignore_patterns;

jupyterlite_sphinx/jupyterlite_sphinx.py

@@ -364,10 +364,10 @@ class TryExamplesDirective(SphinxDirective):
     has_content = True
     required_arguments = 0
     option_spec = {
+        "height": directives.unchanged,
         "theme": directives.unchanged,
         "button_text": directives.unchanged,
         "example_class": directives.unchanged,
-        "min_height": directives.unchanged,
     }
 
     def run(self):
@@ -380,8 +380,8 @@ def run(self):
         )
 
         button_text = self.options.pop("button_text", "Try it with Jupyterlite!")
+        height = self.options.pop("height", None)
         example_class = self.options.pop("example_class", "")
-        min_height = self.options.pop("min_height", "200px")
 
         # We need to get the relative path back to the documentation root from
         # whichever file the docstring content is in.
@@ -456,7 +456,7 @@ def run(self):
             '<button class="try_examples_button" '
             f"onclick=\"window.tryExamplesShowIframe('{examples_div_id}',"
             f"'{iframe_div_id}','{iframe_parent_div_id}','{iframe_src}',"
-            f"'{min_height}')\">"
+            f"'{height}')\">"
             f"{button_text}</button>"
             "</div>"
         )
@@ -499,7 +499,6 @@ def _process_autodoc_docstrings(app, what, name, obj, options, lines):
         "theme": app.config.try_examples_global_theme,
         "button_text": app.config.try_examples_global_button_text,
         "example_class": app.config.try_examples_global_example_class,
-        "min_height": app.config.try_examples_global_min_height,
     }
     try_examples_options = {
         key: value for key, value in try_examples_options.items() if value is not None
@@ -608,10 +607,6 @@ def setup(app):
 
     app.add_config_value("global_enable_try_examples", default=False, rebuild=True)
     app.add_config_value("try_examples_global_theme", default=None, rebuild=True)
-    app.add_config_value(
-        "try_examples_global_example_class", default=None, rebuild="html"
-    )
-    app.add_config_value("try_examples_global_min_height", default=None, rebuild="html")
     app.add_config_value(
         "try_examples_global_button_text",
         default=None,