added jupyter notebooks to the html documentation (VincentStimper#38)

* added jupyter notebooks to the html documentation * the mkdocs workflow installs mkdocs-jupyter * replacing in docs symbolic links to file by symbolic link to folder --------- Co-authored-by: Vincent Berenz <[email protected]>
Steven-meta · Jun 6, 2023 · 29a480c · 29a480c
1 parent 11c49ef
commit 29a480c
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/.github/workflows/mkdocs.yaml b/.github/workflows/mkdocs.yaml
@@ -13,5 +13,5 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material mkdocstrings[python]
+      - run: pip install mkdocs-material mkdocstrings[python] mkdocs-jupyter
       - run: mkdocs gh-deploy --force
diff --git a/docs/examples b/docs/examples
@@ -0,0 +1 @@
+../examples
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,12 +5,26 @@ site_url: https://github.com/VincentStimper/normalizing-flows
 plugins:
   - search
   - autorefs
+  - mkdocs-jupyter
   - mkdocstrings:
       handlers:
         python:
           options:
             show_submodules: true
 
 nav:
-  - about: index.md
+  - About: index.md
   - API: references.md
+  - Examples:
+    - augmented_flow: examples/augmented_flow.ipynb
+    - change_base_distribution: examples/change_base_distribution.ipynb
+    - circular_nsf: examples/circular_nsf.ipynb
+    - comparison_plan_rad_aff: examples/comparison_plan_rad_aff.ipynb
+    - glow: examples/glow.ipynb
+    - image: examples/image.ipynb
+    - neural_spline_flow: examples/neural_spline_flow.ipynb
+    - paper_example_nsf: examples/paper_example_nsf.ipynb
+    - planar: examples/planar.ipynb
+    - real_nvp: examples/real_nvp.ipynb
+    - residual: examples/residual.ipynb
+    - vae: examples/vae.ipynb