SPY-541-fix-images-in-doc-notebooks

LorenFrankLab · Jun 12, 2023 · 5db203e · 5db203e
1 parent 7ac14c6
commit 5db203e
Show file tree

Hide file tree

Showing 12 changed files with 99 additions and 436 deletions.
diff --git a/.gitignore b/.gitignore
@@ -171,8 +171,8 @@ dj_local_conf.json
 
 !/.vscode/extensions.json
 !/.vscode/settings.json
-!/notebooks/dlc_scratch.png
-!/notebooks/dlc_existing.png
+!/notebooks/notebook-images/dlc_scratch.png
+!/notebooks/notebook-images/dlc_existing.png
 
 # Documentation
 docs/site/

diff --git a/docs/build-docs.sh b/docs/build-docs.sh
@@ -8,6 +8,7 @@
 cp ./CHANGELOG.md ./docs/src/
 cp ./LICENSE ./docs/src/LICENSE.md
 cp -r ./notebooks/ ./docs/src/
+cp -r ./notebook-images ./docs/src/notebooks
 
 # Get major version
 FULL_VERSION=$(grep -m 1 version pyproject.toml | tr -s ' ' | tr -d '"' | tr -d "'" | cut -d' ' -f3)

diff --git a/notebooks/curation.png → notebook-images/curation.png b/notebooks/curation.png → notebook-images/curation.png
diff --git a/notebooks/dlc_existing.png → notebook-images/dlc_existing.png b/notebooks/dlc_existing.png → notebook-images/dlc_existing.png
diff --git a/notebooks/dlc_scratch.png → notebook-images/dlc_scratch.png b/notebooks/dlc_scratch.png → notebook-images/dlc_scratch.png
diff --git a/notebooks/mydask.png → notebook-images/mydask.png b/notebooks/mydask.png → notebook-images/mydask.png
diff --git a/notebooks/recording.png → notebook-images/recording.png b/notebooks/recording.png → notebook-images/recording.png
diff --git a/notebooks/unittable.png → notebook-images/unittable.png b/notebooks/unittable.png → notebook-images/unittable.png
diff --git a/notebooks/workspace.png → notebook-images/workspace.png b/notebooks/workspace.png → notebook-images/workspace.png
diff --git a/notebooks/02_curation.ipynb b/notebooks/02_curation.ipynb
@@ -443,19 +443,19 @@
    "source": [
     "This will take you to a workspace on the `sortingview` app. The workspace, which you can think of as a list of recording and associated sorting objects, was created at the end of spike sorting. On the workspace view, you will see a set of recordings that have been added to the workspace. \n",
     "\n",
-    "![alt text](workspace.png \"Workspace view\")\n",
+    "![Workspace view](./../notebook-images/workspace.png)\n",
     "\n",
     "Clicking on a recording then takes you to a page that gives you information about the recording as well as the associated sorting objects. \n",
     "\n",
-    "![alt text](recording.png \"Recording view\")\n",
+    "![Recording view](./../notebook-images/recording.png)\n",
     "\n",
     "Click on a sorting to see the curation view. Try exploring the many visualization widgets. \n",
     "\n",
-    "![alt text](unittable.png \"Unit table\")\n",
+    "![Unit table](./../notebook-images/unittable.png)\n",
     "\n",
     "The most important is the `Units Table` and the `Curation` menu, which allows you to give labels to the units. The curation labels will persist even if you suddenly lose connection to the app; this is because the curaiton actions are appended to the workspace as soon as they are created. Note that if you are not logged in with your Google account, `Curation` menu may not be visible. Log in and refresh the page to access this feature.\n",
     "\n",
-    "![alt text](curation.png \"Curation\")"
+    "![Curation](./../notebook-images/curation.png)"
    ]
   },
   {
@@ -468,7 +468,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3.10.5 64-bit",
+   "display_name": "base",
    "language": "python",
    "name": "python3"
   },
@@ -482,11 +482,11 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.5"
+   "version": "3.9.7 (default, Sep 16 2021, 13:09:58) \n[GCC 7.5.0]"
   },
   "vscode": {
    "interpreter": {
-    "hash": "8a94588eda9d64d9e9a351ab8144e55b1fabf5113b54e67dd26a8c27df0381b3"
+    "hash": "660bf1f5e0ab56266266a9ce589faf8a830d2aef7f15e27b16e9135d893e3d0b"
    }
   }
  },