Adding notebooks to docs

Signed-off-by: Pradyot Ranjan <99216956+pradyotRanjan@users.noreply.github.com>

Author: prady0t

docs/notebooks.md

@@ -0,0 +1 @@
+- [Sparse Finch](examples/sparse_finch.ipynb)

mkdocs.yml

@@ -52,6 +52,7 @@ plugins:
   - gen-files:
       scripts:
       - scripts/gen_ref_pages.py
+      - scripts/copy_notebooks.py
   - literate-nav
   - mkdocstrings:
       handlers:
@@ -75,6 +76,8 @@ plugins:
       include_source: true
       execute: true
       ignore: ["__init__.py", "utils.py", "gen_logo.py"]
+      include:
+        - examples/*.ipynb
 
 nav:
   - Home:
@@ -100,3 +103,5 @@ nav:
     - completed-tasks.md
     - changelog.md
     - conduct.md
+  - Notebooks:
+    - notebooks.md

scripts/copy_notebooks.py

@@ -0,0 +1,10 @@
+import shutil
+from pathlib import Path
+
+source_dir = Path("examples")
+dest_dir = Path("docs/examples")
+
+dest_dir.mkdir(parents=True, exist_ok=True)
+
+for notebook in source_dir.glob("*.ipynb"):
+    shutil.copy2(notebook, dest_dir / notebook.name)