Sphinx gallery

.github/workflows/build_docs.yml

@@ -24,6 +24,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -e .[doc]
+          pip install pymatreader
 
       - name: Build documentation
         run: |

.gitignore

@@ -134,4 +134,7 @@ dmypy.json
 my_project_ll_config.yaml
 
 # VSCode ignore
-.vscode
+.vscode
+
+# sphinx gallery
+docs/auto_examples/

docs/API/io.rst

@@ -0,0 +1,8 @@
+File IO
+=======
+
+eog-learn provides some helper functions for reading data from open-access
+EEG-eyetracking datasets.
+
+.. automodule:: eoglearn.io.eegeyenet
+    :members:

docs/conf.py

@@ -27,6 +27,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.todo",
     "sphinx_design",
+    "sphinx_gallery.gen_gallery",
     "sphinxemoji.sphinxemoji",
 ]
 
@@ -83,3 +84,9 @@
     "dtype",
     "object",
 }
+
+# Sphinx Gallery configuration ------------------------------------------------
+sphinx_gallery_conf = {
+    "examples_dirs": "../examples",  # path to tutorial python scripts
+    "gallery_dirs": "auto_examples",  # path to where to save gallery generated output
+}

docs/index.rst

@@ -18,4 +18,5 @@ Please see the contributing section or the Roadmap for details on how to get inv
    installation
    implementation
    API/API_index
+   auto_examples/index.rst
    contributing

examples/README.txt

@@ -0,0 +1,5 @@
+eog-learn Tutorials
+===================
+
+Here we list some (work in progress!) tutorials for using eog-learn with eeg-eyetracking
+data. Mainly these will cover loading eeg-eyetracking data and training the model.

examples/plot_eegeyenet.py

@@ -0,0 +1,19 @@
+"""
+
+Load an example file from EEGEyeNet
+===================================
+
+This example shows how to load an example file from EEGEyeNet, an open-access
+dataset of EEG and eyetracking data. We'll load one file from the "dots" task,
+which presents a subject with a series of dots at fixed locations on the screen.
+"""
+
+# %%
+# Import the necessary packages
+from eoglearn.datasets import fetch_eegeyenet
+from eoglearn.io import read_raw_eegeyenet
+
+fpath = fetch_eegeyenet()
+fname = fpath / "EP10_DOTS1_EEG.mat"
+raw = read_raw_eegeyenet(fname)
+raw.plot()