docs: better navigation and notebooks (#20)

### Summary of Changes * Show "Back to Top" button * Allow to attach documents to section headers (good for overview pages) * Add notebook support
Safe-DS · Mar 15, 2023 · dd2bdef · dd2bdef
1 parent 0d9a51a
commit dd2bdef
Show file tree

Hide file tree

Showing 3 changed files with 124 additions and 2 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -4,7 +4,7 @@ repo_name: Safe-DS/Stdlib-Examples
 
 nav:
   - Home:
-    - README: README.md
+    - README.md
     - Changelog: CHANGELOG.md
   - Examples:
     - Titanic: examples/titanic.md
@@ -37,8 +37,10 @@ theme:
   features:
     - content.code.copy
     - navigation.tabs
+    - navigation.indexes
     - navigation.instant
     - navigation.sections
+    - navigation.top
 
 plugins:
   - mkdocstrings:
@@ -58,6 +60,11 @@ plugins:
   - autorefs
   - glightbox
   - search
+  - mkdocs-jupyter:
+      include: ["*.ipynb"]
+      execute: true
+      allow_errors: false
+      include_source: true
 
 watch:
   - src

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,6 +31,7 @@ mkdocs-glightbox = "^0.3.1"
 mkdocs-literate-nav = "^0.6.0"
 mkdocs-material = "^9.1.2"
 mkdocs-section-index = "^0.3.5"
+mkdocs-jupyter = "^0.23.0"
 
 [build-system]
 requires = ["poetry-core"]