docs: add Open in Binder badge to notebooks

alphanome-ai · Oct 13, 2023 · 0c62930 · 0c62930
1 parent 3c6d8cb
commit 0c62930
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 6 deletions.
diff --git a/docs/source/notebooks/comprehensive_developer_guide.ipynb b/docs/source/notebooks/comprehensive_developer_guide.ipynb
@@ -2,11 +2,38 @@
     "cells": [
         {
             "cell_type": "code",
-            "execution_count": 2,
+            "execution_count": 1,
             "metadata": {
                 "nbsphinx": "hidden"
             },
-            "outputs": [],
+            "outputs": [
+                {
+                    "data": {
+                        "text/html": [
+                            "\n",
+                            "                <script type=\"application/javascript\" id=\"jupyter_black\">\n",
+                            "                (function() {\n",
+                            "                    if (window.IPython === undefined) {\n",
+                            "                        return\n",
+                            "                    }\n",
+                            "                    var msg = \"WARNING: it looks like you might have loaded \" +\n",
+                            "                        \"jupyter_black in a non-lab notebook with \" +\n",
+                            "                        \"`is_lab=True`. Please double check, and if \" +\n",
+                            "                        \"loading with `%load_ext` please review the README!\"\n",
+                            "                    console.log(msg)\n",
+                            "                    alert(msg)\n",
+                            "                })()\n",
+                            "                </script>\n",
+                            "                "
+                        ],
+                        "text/plain": [
+                            "<IPython.core.display.HTML object>"
+                        ]
+                    },
+                    "metadata": {},
+                    "output_type": "display_data"
+                }
+            ],
             "source": [
                 "# Note: this cell is hidden from the HTML output. Read more: https://nbsphinx.readthedocs.io/en/0.2.1/hidden-cells.html\n",
                 "import jupyter_black\n",
@@ -34,6 +61,7 @@
                 "Alternatively, you can also run the notebook directly in your browser using Google Colab:\n",
                 "\n",
                 "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/comprehensive_developer_guide.ipynb)\n",
+                "[![My Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/alphanome-ai/sec-ai/main?filepath=docs/source/notebooks/comprehensive_developer_guide.ipynb)\n",
                 "\n",
                 "Let's dive in!"
             ]
@@ -61,4 +89,4 @@
     },
     "nbformat": 4,
     "nbformat_minor": 2
-}
+}
diff --git a/docs/source/notebooks/quickstart_user_guide.ipynb b/docs/source/notebooks/quickstart_user_guide.ipynb
@@ -2,11 +2,38 @@
     "cells": [
         {
             "cell_type": "code",
-            "execution_count": 2,
+            "execution_count": 1,
             "metadata": {
                 "nbsphinx": "hidden"
             },
-            "outputs": [],
+            "outputs": [
+                {
+                    "data": {
+                        "text/html": [
+                            "\n",
+                            "                <script type=\"application/javascript\" id=\"jupyter_black\">\n",
+                            "                (function() {\n",
+                            "                    if (window.IPython === undefined) {\n",
+                            "                        return\n",
+                            "                    }\n",
+                            "                    var msg = \"WARNING: it looks like you might have loaded \" +\n",
+                            "                        \"jupyter_black in a non-lab notebook with \" +\n",
+                            "                        \"`is_lab=True`. Please double check, and if \" +\n",
+                            "                        \"loading with `%load_ext` please review the README!\"\n",
+                            "                    console.log(msg)\n",
+                            "                    alert(msg)\n",
+                            "                })()\n",
+                            "                </script>\n",
+                            "                "
+                        ],
+                        "text/plain": [
+                            "<IPython.core.display.HTML object>"
+                        ]
+                    },
+                    "metadata": {},
+                    "output_type": "display_data"
+                }
+            ],
             "source": [
                 "# Note: this cell is hidden from the HTML output. Read more: https://nbsphinx.readthedocs.io/en/0.2.1/hidden-cells.html\n",
                 "import jupyter_black\n",
@@ -34,6 +61,7 @@
                 "Alternatively, you can also run the notebook directly in your browser using Google Colab:\n",
                 "\n",
                 "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/quickstart_user_guide.ipynb)\n",
+                "[![My Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/alphanome-ai/sec-ai/main?filepath=docs/source/notebooks/quickstart_user_guide.ipynb)\n",
                 "\n",
                 "Let's get started!"
             ]
@@ -61,4 +89,4 @@
     },
     "nbformat": 4,
     "nbformat_minor": 2
-}
+}