Merge pull request #165 from scipp/debug-endless-docs-build

Debug endless docs build
scipp · Jan 24, 2025 · 23cb90b · 23cb90b
2 parents e475965 + e4f61e0
commit 23cb90b
Showing 1 changed file with 28 additions and 13 deletions.
diff --git a/docs/developer/gui.ipynb b/docs/developer/gui.ipynb
@@ -168,23 +168,25 @@
     "ess_widget = workflow_widget()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Note that the order of operations here is important.\n",
+    "We have to first set the workflow, then display the widget, and then interact with the widget programmatically.\n",
+    "Otherwise, the docs build can freeze.\n",
+    "It is unclear why this happens."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "nbsphinx": "hidden"
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "from ess.reduce.ui import WorkflowWidget\n",
     "\n",
-    "# Select Workflow\n",
-    "ess_widget.children[0].children[0].value = RandomDistributionWorkflow\n",
-    "# Set Output Parameter\n",
-    "body_widget: WorkflowWidget = ess_widget.children[1].children[0]\n",
-    "body_widget.output_selection_box.typical_outputs_widget.value = [Histogram]\n",
-    "body_widget.parameter_box.parameter_refresh_button.click()\n",
-    "body_widget.result_box.run_button.click()"
+    "ess_widget.children[0].children[0].value = RandomDistributionWorkflow"
    ]
   },
   {
@@ -196,6 +198,19 @@
     "ess_widget"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "body_widget: WorkflowWidget = ess_widget.children[1].children[0]\n",
+    "body_widget.output_selection_box.typical_outputs_widget.value = [Histogram]\n",
+    "\n",
+    "body_widget.parameter_box.parameter_refresh_button.click()\n",
+    "body_widget.result_box.run_button.click()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -308,7 +323,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "lime-dev-310",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -322,9 +337,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.13"
+   "version": "3.10.14"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }