doc: mkdocs-jupyter in requirements for docs

det-lab · Dec 9, 2024 · 4c0ae83 · 4c0ae83
1 parent 71a9f80
commit 4c0ae83
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -4,5 +4,9 @@ repo_url: https://github.com/det-lab/kaitai_struct_awkward_runtime
 edit_uri: edit/main/docs/
 theme:
   name: material
+  custom_dir: overrides
   features:
-    - content.action.edit
+    - content.action.edit
+plugins:
+  - mkdocs-jupyter:
+      include_source: true
diff --git a/overrides/main.html b/overrides/main.html
@@ -0,0 +1,11 @@
+{% extends "base.html" %}
+
+{% block content %}
+{% if page.nb_url %}
+    <a href="{{ page.nb_url }}" title="Download Notebook" class="md-content__button md-icon">
+        {% include ".icons/material/download.svg" %}
+    </a>
+{% endif %}
+
+{{ super() }}
+{% endblock content %}
diff --git a/pyproject.toml b/pyproject.toml
@@ -45,7 +45,8 @@ dev = [
   "pytest-cov >=3",
 ]
 docs = [
-  "mkdocs-material"
+  "mkdocs-material",
+  "mkdocs-jupyter"
 ]
 
 [project.urls]