[DOC] Add demo notebooks (#6)

* doc: Add demo notebooks

* Workflow: Also add in test doc build

Author: eleanorfrajka

.github/workflows/docs.yml

@@ -48,7 +48,8 @@ jobs:
       shell: bash -l {0}
       run: |
         set -e
-        jupyter nbconvert --to notebook --execute notebooks/demo.ipynb --output=demo-output.ipynb --ExecutePreprocessor.allow_errors=False
+        jupyter nbconvert --to notebook --execute notebooks/demo_instrument.ipynb --output=demo_instrument-output.ipynb --ExecutePreprocessor.allow_errors=True
+        jupyter nbconvert --to notebook --execute notebooks/demo_mooring.ipynb --output=demo_mooring-output.ipynb --ExecutePreprocessor.allow_errors=True
         mv notebooks/*output.ipynb docs/source/
         pushd docs
         make clean html

.github/workflows/docs_deploy.yml

@@ -44,7 +44,8 @@ jobs:
       shell: bash -l {0}
       run: |
         set -e
-        jupyter nbconvert --to notebook --execute notebooks/demo.ipynb --output=demo-output.ipynb --ExecutePreprocessor.allow_errors=True
+        jupyter nbconvert --to notebook --execute notebooks/demo_instrument.ipynb --output=demo_instrument-output.ipynb --ExecutePreprocessor.allow_errors=True
+        jupyter nbconvert --to notebook --execute notebooks/demo_mooring.ipynb --output=demo_mooring-output.ipynb --ExecutePreprocessor.allow_errors=True
         mv notebooks/*output.ipynb docs/source/
         pushd docs
         make clean html

docs/source/index.rst

@@ -48,8 +48,8 @@ Contents
    :maxdepth: 1
    :caption: Examples
 
-   examples/rapid
-
+   demo_instrument-output.ipynb
+   demo_mooring-output.ipynb
 
 .. toctree::
    :maxdepth: 2