Merge pull request #145 from kabilar/notebooks

Display Jupyter Notebooks

Author: kabilar

.github/workflows/build-docs.yaml

@@ -2,13 +2,16 @@ name: Build MkDocs
 on:
   push:
   pull_request:
+  workflow_dispatch:
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v1
+        uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Install version of Python
         uses: actions/setup-python@v5

.github/workflows/codespell.yml

@@ -17,6 +17,6 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Codespell
         uses: codespell-project/actions-codespell@v2

.github/workflows/publishdocs.yaml

@@ -3,16 +3,19 @@ on:
   push:
     branches:
       - master
+  workflow_dispatch:
 
 jobs:
   build:
     name: Deploy docs
     runs-on: ubuntu-latest
     steps:
       - name: Checkout master
-        uses: actions/checkout@v1
+        uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Deploy docs
         uses: mhausenblas/mkdocs-deploy-gh-pages@master
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "doc/example-notebooks"]
+	path = docs/example-notebooks
+	url = https://github.com/dandi/example-notebooks
+	datalad-url = https://github.com/dandi/example-notebooks

docs/example-notebooks

@@ -63,6 +63,12 @@ nav:
   - DANDI Hub: "50_hub.md"
   - Tutorials:
     - Dandiset Examples: https://dandi.github.io/example-notebooks
+    - DANDI User Guide, Part I: "example-notebooks/dandi/DANDI User Guide, Part I.ipynb"
+    - DANDI User Guide, Part II: "example-notebooks/dandi/DANDI User Guide, Part II.ipynb"
+    - Simple Dandiset Search: "example-notebooks/tutorials/neurodatarehack_2024/simple_dandiset_search.ipynb"
+    - Advanced Asset Search: "example-notebooks/tutorials/cosyne_2023/advanced_asset_search.ipynb"
+    - Streaming and interacting with NWB data: "example-notebooks/tutorials/bcm_2024/analysis-demo.ipynb"
+    - NWB Widget Demo: "example-notebooks/demos/NWBWidget-demo.ipynb"
   - Health Status:
     - Dandisets: https://github.com/dandi/dandisets-healthstatus
     - Services: https://status.dandiarchive.org
@@ -88,6 +94,9 @@ markdown_extensions:
 plugins:
   - search
   - open-in-new-tab
+  - mkdocs-jupyter:
+      ignore_h1_titles: True
+      include: ["*.ipynb"]
 
 # Customize theme
 extra:

mkdocs.yml

@@ -1,3 +1,4 @@
 mkdocs-material>=9.6.3
 pymdown-extensions
-mkdocs-open-in-new-tab
+mkdocs-open-in-new-tab
+mkdocs-jupyter