add colab link as header to notebooks in docs

spatial-model-editor · Aug 17, 2021 · 46508a8 · 46508a8
1 parent 73e34cf
commit 46508a8
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,11 +8,11 @@ repos:
     - id: trailing-whitespace
 
   - repo: https://github.com/psf/black
-    rev: 21.6b0
+    rev: 21.7b0
     hooks:
     - id: black
 
   - repo: https://github.com/kynan/nbstripout
-    rev: 0.4.0
+    rev: 0.5.0
     hooks:
     - id: nbstripout
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,6 +40,13 @@
 
 autosummary_generate = True
 
+nbsphinx_prolog = """
+|colab-icon|_ `Interactive online version <https://colab.research.google.com/github/spatial-model-editor/sme_contrib/blob/master/docs/{{ env.doc2path(env.docname, base=None) }}>`_
+
+.. |colab-icon| image:: https://colab.research.google.com/assets/colab-badge.svg
+.. _colab-icon: https://colab.research.google.com/github/spatial-model-editor/sme_contrib/blob/master/docs/{{ env.doc2path(env.docname, base=None) }}
+"""
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

diff --git a/docs/notebooks/plot.ipynb b/docs/notebooks/plot.ipynb
@@ -15,6 +15,7 @@
    },
    "outputs": [],
    "source": [
+    "!pip install -q sme_contrib\n",
     "import sme\n",
     "import sme_contrib.plot as smeplot\n",
     "from matplotlib import pyplot as plt"