Deployed 7e566f1 to 0.4 with MkDocs 1.5.3 and mike 2.0.0

LorenFrankLab · Dec 1, 2023 · a417672 · a417672
1 parent bacc7fc
commit a417672
Show file tree

Hide file tree

Showing 119 changed files with 74,070 additions and 40,856 deletions.
diff --git a/0.4/404.html b/0.4/404.html
diff --git a/0.4/CHANGELOG/index.html b/0.4/CHANGELOG/index.html
diff --git a/0.4/LICENSE/index.html b/0.4/LICENSE/index.html
diff --git a/0.4/api/src/spyglass/cli/cli/index.html → 0.4/api/cli/cli/index.html b/0.4/api/src/spyglass/cli/cli/index.html → 0.4/api/cli/cli/index.html
diff --git a/...c/spyglass/common/common_behav/index.html → 0.4/api/common/common_behav/index.html b/...c/spyglass/common/common_behav/index.html → 0.4/api/common/common_behav/index.html
diff --git a/.../spyglass/common/common_device/index.html → 0.4/api/common/common_device/index.html b/.../spyglass/common/common_device/index.html → 0.4/api/common/common_device/index.html
diff --git a/...src/spyglass/common/common_dio/index.html → 0.4/api/common/common_dio/index.html b/...src/spyglass/common/common_dio/index.html → 0.4/api/common/common_dio/index.html
diff --git a/...c/spyglass/common/common_ephys/index.html → 0.4/api/common/common_ephys/index.html b/...c/spyglass/common/common_ephys/index.html → 0.4/api/common/common_ephys/index.html
diff --git a/.../spyglass/common/common_filter/index.html → 0.4/api/common/common_filter/index.html b/.../spyglass/common/common_filter/index.html → 0.4/api/common/common_filter/index.html
diff --git a/...pyglass/common/common_interval/index.html → 0.4/api/common/common_interval/index.html b/...pyglass/common/common_interval/index.html → 0.4/api/common/common_interval/index.html
diff --git a/...src/spyglass/common/common_lab/index.html → 0.4/api/common/common_lab/index.html b/...src/spyglass/common/common_lab/index.html → 0.4/api/common/common_lab/index.html
diff --git a/...spyglass/common/common_nwbfile/index.html → 0.4/api/common/common_nwbfile/index.html b/...spyglass/common/common_nwbfile/index.html → 0.4/api/common/common_nwbfile/index.html
diff --git a/...pyglass/common/common_position/index.html → 0.4/api/common/common_position/index.html b/...pyglass/common/common_position/index.html → 0.4/api/common/common_position/index.html
diff --git a/.../spyglass/common/common_region/index.html → 0.4/api/common/common_region/index.html b/.../spyglass/common/common_region/index.html → 0.4/api/common/common_region/index.html
diff --git a/.../spyglass/common/common_ripple/index.html → 0.4/api/common/common_ripple/index.html b/.../spyglass/common/common_ripple/index.html → 0.4/api/common/common_ripple/index.html
diff --git a/...spyglass/common/common_sensors/index.html → 0.4/api/common/common_sensors/index.html b/...spyglass/common/common_sensors/index.html → 0.4/api/common/common_sensors/index.html
diff --git a/...spyglass/common/common_session/index.html → 0.4/api/common/common_session/index.html b/...spyglass/common/common_session/index.html → 0.4/api/common/common_session/index.html
diff --git a/...spyglass/common/common_subject/index.html → 0.4/api/common/common_subject/index.html b/...spyglass/common/common_subject/index.html → 0.4/api/common/common_subject/index.html
diff --git a/...rc/spyglass/common/common_task/index.html → 0.4/api/common/common_task/index.html b/...rc/spyglass/common/common_task/index.html → 0.4/api/common/common_task/index.html
diff --git a/...api/src/spyglass/common/errors/index.html → 0.4/api/common/errors/index.html b/...api/src/spyglass/common/errors/index.html → 0.4/api/common/errors/index.html
diff --git a/...ass/common/populate_all_common/index.html → ...api/common/populate_all_common/index.html b/...ass/common/populate_all_common/index.html → ...api/common/populate_all_common/index.html
diff --git a/...common/prepopulate/prepopulate/index.html → ...common/prepopulate/prepopulate/index.html b/...common/prepopulate/prepopulate/index.html → ...common/prepopulate/prepopulate/index.html
diff --git a/...glass/common/signal_processing/index.html → 0.4/api/common/signal_processing/index.html b/...glass/common/signal_processing/index.html → 0.4/api/common/signal_processing/index.html
diff --git a/...ss/data_import/insert_sessions/index.html → ...pi/data_import/insert_sessions/index.html b/...ss/data_import/insert_sessions/index.html → ...pi/data_import/insert_sessions/index.html
diff --git a/.../spyglass/decoding/clusterless/index.html → 0.4/api/decoding/clusterless/index.html b/.../spyglass/decoding/clusterless/index.html → 0.4/api/decoding/clusterless/index.html
diff --git a/...api/src/spyglass/decoding/core/index.html → 0.4/api/decoding/core/index.html b/...api/src/spyglass/decoding/core/index.html → 0.4/api/decoding/core/index.html
diff --git a/...decoding/dj_decoder_conversion/index.html → ...decoding/dj_decoder_conversion/index.html b/...decoding/dj_decoder_conversion/index.html → ...decoding/dj_decoder_conversion/index.html
diff --git a/...pyglass/decoding/sorted_spikes/index.html → 0.4/api/decoding/sorted_spikes/index.html b/...pyglass/decoding/sorted_spikes/index.html → 0.4/api/decoding/sorted_spikes/index.html
diff --git a/...pyglass/decoding/visualization/index.html → 0.4/api/decoding/visualization/index.html b/...pyglass/decoding/visualization/index.html → 0.4/api/decoding/visualization/index.html
diff --git a/...decoding/visualization_1D_view/index.html → ...decoding/visualization_1D_view/index.html b/...decoding/visualization_1D_view/index.html → ...decoding/visualization_1D_view/index.html
diff --git a/...decoding/visualization_2D_view/index.html → ...decoding/visualization_2D_view/index.html b/...decoding/visualization_2D_view/index.html → ...decoding/visualization_2D_view/index.html
diff --git a/...iews/SpikeSortingRecordingView/index.html → ...iews/SpikeSortingRecordingView/index.html b/...iews/SpikeSortingRecordingView/index.html → ...iews/SpikeSortingRecordingView/index.html
diff --git a/.../figurl_views/SpikeSortingView/index.html → .../figurl_views/SpikeSortingView/index.html b/.../figurl_views/SpikeSortingView/index.html → .../figurl_views/SpikeSortingView/index.html
diff --git a/.../prepare_spikesortingview_data/index.html → .../prepare_spikesortingview_data/index.html b/.../prepare_spikesortingview_data/index.html → .../prepare_spikesortingview_data/index.html
diff --git a/0.4/api/src/spyglass/_version/index.html → 0.4/api/index.html b/0.4/api/src/spyglass/_version/index.html → 0.4/api/index.html
diff --git a/...glass/lfp/analysis/v1/lfp_band/index.html → 0.4/api/lfp/analysis/v1/lfp_band/index.html b/...glass/lfp/analysis/v1/lfp_band/index.html → 0.4/api/lfp/analysis/v1/lfp_band/index.html
diff --git a/...src/spyglass/lfp/lfp_electrode/index.html → 0.4/api/lfp/lfp_electrode/index.html b/...src/spyglass/lfp/lfp_electrode/index.html → 0.4/api/lfp/lfp_electrode/index.html
diff --git a/.../src/spyglass/lfp/lfp_imported/index.html → 0.4/api/lfp/lfp_imported/index.html b/.../src/spyglass/lfp/lfp_imported/index.html → 0.4/api/lfp/lfp_imported/index.html
diff --git a/...api/src/spyglass/lfp/lfp_merge/index.html → 0.4/api/lfp/lfp_merge/index.html b/...api/src/spyglass/lfp/lfp_merge/index.html → 0.4/api/lfp/lfp_merge/index.html
diff --git a/0.4/api/src/spyglass/lfp/v1/lfp/index.html → 0.4/api/lfp/v1/lfp/index.html b/0.4/api/src/spyglass/lfp/v1/lfp/index.html → 0.4/api/lfp/v1/lfp/index.html
diff --git a/...c/spyglass/lfp/v1/lfp_artifact/index.html → 0.4/api/lfp/v1/lfp_artifact/index.html b/...c/spyglass/lfp/v1/lfp_artifact/index.html → 0.4/api/lfp/v1/lfp_artifact/index.html
diff --git a/.../v1/lfp_artifact_MAD_detection/index.html → .../v1/lfp_artifact_MAD_detection/index.html b/.../v1/lfp_artifact_MAD_detection/index.html → .../v1/lfp_artifact_MAD_detection/index.html
diff --git a/..._artifact_difference_detection/index.html → ..._artifact_difference_detection/index.html b/..._artifact_difference_detection/index.html → ..._artifact_difference_detection/index.html
diff --git a/...pi/src/spyglass/lock/file_lock/index.html → 0.4/api/lock/file_lock/index.html b/...pi/src/spyglass/lock/file_lock/index.html → 0.4/api/lock/file_lock/index.html
diff --git a/0.4/api/make_pages.py b/0.4/api/make_pages.py
@@ -4,15 +4,36 @@
 from pathlib import Path
 
 import mkdocs_gen_files
+from mkdocs.utils import log
+
+ignored_stems = ["__init__", "_version"]
+
+added = 0
+add_limit = None
 
 nav = mkdocs_gen_files.Nav()
-for path in sorted(Path("src").glob("**/*.py")):
-    if path.stem == "__init__" or "cython" in path.stem:
+for path in sorted(Path("src/spyglass/").glob("**/*.py")):
+    if path.stem in ignored_stems or "cython" in path.stem:
         continue
-    with mkdocs_gen_files.open(f"api/{path.with_suffix('')}.md", "w") as f:
+    rel_path = path.relative_to("src/spyglass")
+    with mkdocs_gen_files.open(f"api/{rel_path.with_suffix('')}.md", "w") as f:
         module_path = ".".join([p for p in path.with_suffix("").parts])
         print(f"::: {module_path}", file=f)
-    nav[path.parts] = f"{path.with_suffix('')}.md"
+    nav[rel_path.parts] = f"{rel_path.with_suffix('')}.md"
+
+    if add_limit is not None:
+        if added < add_limit:
+            log.warning(f"Generated {rel_path.with_suffix('')}.md")
+            added += 1
+        else:
+            break
+
+if add_limit is not None:
+    from IPython import embed
+
+    embed()
+
 
 with mkdocs_gen_files.open("api/navigation.md", "w") as nav_file:
+    nav_file.write("* [Overview](../api/index.md)\n")
     nav_file.writelines(nav.build_literate_nav())