DOC: update tutorial documentation

- add `nbsphinx` and `nbsphinx-link` dependencies to directly include new jupyter-notebook tutorials in docs - minor typo corrections and renames in tutorials - related: #185
pik-copan · Jan 8, 2024 · bcc009d · bcc009d
1 parent ed6fce5
commit bcc009d
Show file tree

Hide file tree

Showing 19 changed files with 109 additions and 94 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -45,7 +45,7 @@ install:
 
     # testing dependencies
     - travis_retry conda install -c conda-forge tox flake8 pylint pytest-xdist pytest-cov codecov
-    - travis_retry conda install -c conda-forge networkx matplotlib cartopy sphinx
+    - travis_retry conda install -c conda-forge networkx matplotlib cartopy sphinx nbsphinx nbsphinx-link
 
     # debugging info
     - conda info -a

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -38,7 +38,9 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages'
+    'sphinx.ext.githubpages',
+    'nbsphinx',
+    'nbsphinx_link',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst
@@ -4,11 +4,12 @@ Tutorials
 
 The tutorials are designed to be self-explanatory. For further details on the
 used classes and methods please refer to the :doc:`api_doc`.
+The tutorials are set up as Jupyter notebooks that can be accessed read-only
+through the links below. The original, runnable notebook files can be found
+in the ``examples`` folder of ``pyunicorn``'s root directory.
 
 .. toctree::
     :maxdepth: 1
+    :glob:
 
-    tutorials/climate_network_1
-    tutorials/recurrence_network_1
-
-
+    tutorials/*
diff --git a/docs/source/tutorials/ClimateNetworks.nblink b/docs/source/tutorials/ClimateNetworks.nblink
@@ -0,0 +1,6 @@
+{
+  "path": "../../../examples/tutorials/ClimateNetworks.ipynb",
+  "extra-media": [
+    "../../../examples/tutorials/images"
+  ]
+}
diff --git a/docs/source/tutorials/EventSeriesAnalysis.nblink b/docs/source/tutorials/EventSeriesAnalysis.nblink
@@ -0,0 +1,6 @@
+{
+  "path": "../../../examples/tutorials/EventSeriesAnalysis.ipynb",
+  "extra-media": [
+    "../../../examples/tutorials/images"
+  ]
+}
diff --git a/docs/source/tutorials/RecurrenceNetworks.nblink b/docs/source/tutorials/RecurrenceNetworks.nblink
@@ -0,0 +1,6 @@
+{
+  "path": "../../../examples/tutorials/RecurrenceNetworks.ipynb",
+  "extra-media": [
+    "../../../examples/tutorials/images"
+  ]
+}
diff --git a/docs/source/tutorials/VisibilityGraphs.nblink b/docs/source/tutorials/VisibilityGraphs.nblink
@@ -0,0 +1,6 @@
+{
+  "path": "../../../examples/tutorials/VisibilityGraphs.ipynb",
+  "extra-media": [
+    "../../../examples/tutorials/images"
+  ]
+}
diff --git a/docs/source/tutorials/climate_network_1.rst b/docs/source/tutorials/climate_network_1.rst
diff --git a/docs/source/tutorials/images/Characteristics_rP.png b/docs/source/tutorials/images/Characteristics_rP.png
diff --git a/docs/source/tutorials/images/ECA.png b/docs/source/tutorials/images/ECA.png
diff --git a/docs/source/tutorials/images/EventSynchronisation.png b/docs/source/tutorials/images/EventSynchronisation.png
diff --git a/docs/source/tutorials/images/HVG.PNG b/docs/source/tutorials/images/HVG.PNG
diff --git a/docs/source/tutorials/images/REcurrencePlot_v2.png b/docs/source/tutorials/images/REcurrencePlot_v2.png
diff --git a/docs/source/tutorials/images/SimpleVG.PNG b/docs/source/tutorials/images/SimpleVG.PNG
diff --git a/docs/source/tutorials/recurrence_network_1.rst b/docs/source/tutorials/recurrence_network_1.rst