Deployed a360fed to ref with MkDocs 1.5.3 and mike 2.0.0

CBroz1 · Feb 12, 2024 · 00131a8 · 00131a8
1 parent b17282e
commit 00131a8
Show file tree

Hide file tree

Showing 199 changed files with 766,371 additions and 0 deletions.
diff --git a/ref/404.html b/ref/404.html
diff --git a/ref/CHANGELOG/index.html b/ref/CHANGELOG/index.html
diff --git a/ref/LICENSE/index.html b/ref/LICENSE/index.html
diff --git a/ref/api/cli/cli/index.html b/ref/api/cli/cli/index.html
diff --git a/ref/api/common/common_behav/index.html b/ref/api/common/common_behav/index.html
diff --git a/ref/api/common/common_device/index.html b/ref/api/common/common_device/index.html
diff --git a/ref/api/common/common_dio/index.html b/ref/api/common/common_dio/index.html
diff --git a/ref/api/common/common_ephys/index.html b/ref/api/common/common_ephys/index.html
diff --git a/ref/api/common/common_filter/index.html b/ref/api/common/common_filter/index.html
diff --git a/ref/api/common/common_interval/index.html b/ref/api/common/common_interval/index.html
diff --git a/ref/api/common/common_lab/index.html b/ref/api/common/common_lab/index.html
diff --git a/ref/api/common/common_nwbfile/index.html b/ref/api/common/common_nwbfile/index.html
diff --git a/ref/api/common/common_position/index.html b/ref/api/common/common_position/index.html
diff --git a/ref/api/common/common_region/index.html b/ref/api/common/common_region/index.html
diff --git a/ref/api/common/common_ripple/index.html b/ref/api/common/common_ripple/index.html
diff --git a/ref/api/common/common_sensors/index.html b/ref/api/common/common_sensors/index.html
diff --git a/ref/api/common/common_session/index.html b/ref/api/common/common_session/index.html
diff --git a/ref/api/common/common_subject/index.html b/ref/api/common/common_subject/index.html
diff --git a/ref/api/common/common_task/index.html b/ref/api/common/common_task/index.html
diff --git a/ref/api/common/common_usage/index.html b/ref/api/common/common_usage/index.html
diff --git a/ref/api/common/errors/index.html b/ref/api/common/errors/index.html
diff --git a/ref/api/common/populate_all_common/index.html b/ref/api/common/populate_all_common/index.html
diff --git a/ref/api/common/prepopulate/prepopulate/index.html b/ref/api/common/prepopulate/prepopulate/index.html
diff --git a/ref/api/common/signal_processing/index.html b/ref/api/common/signal_processing/index.html
diff --git a/ref/api/data_import/insert_sessions/index.html b/ref/api/data_import/insert_sessions/index.html
diff --git a/ref/api/decoding/decoding_merge/index.html b/ref/api/decoding/decoding_merge/index.html
diff --git a/ref/api/decoding/v0/clusterless/index.html b/ref/api/decoding/v0/clusterless/index.html
diff --git a/ref/api/decoding/v0/core/index.html b/ref/api/decoding/v0/core/index.html
diff --git a/ref/api/decoding/v0/dj_decoder_conversion/index.html b/ref/api/decoding/v0/dj_decoder_conversion/index.html
diff --git a/ref/api/decoding/v0/sorted_spikes/index.html b/ref/api/decoding/v0/sorted_spikes/index.html
diff --git a/ref/api/decoding/v0/visualization/index.html b/ref/api/decoding/v0/visualization/index.html
diff --git a/ref/api/decoding/v0/visualization_1D_view/index.html b/ref/api/decoding/v0/visualization_1D_view/index.html
diff --git a/ref/api/decoding/v0/visualization_2D_view/index.html b/ref/api/decoding/v0/visualization_2D_view/index.html
diff --git a/ref/api/decoding/v1/clusterless/index.html b/ref/api/decoding/v1/clusterless/index.html
diff --git a/ref/api/decoding/v1/core/index.html b/ref/api/decoding/v1/core/index.html
diff --git a/ref/api/decoding/v1/dj_decoder_conversion/index.html b/ref/api/decoding/v1/dj_decoder_conversion/index.html
diff --git a/ref/api/decoding/v1/sorted_spikes/index.html b/ref/api/decoding/v1/sorted_spikes/index.html
diff --git a/ref/api/decoding/v1/waveform_features/index.html b/ref/api/decoding/v1/waveform_features/index.html
diff --git a/ref/api/index.html b/ref/api/index.html
diff --git a/ref/api/lfp/analysis/v1/lfp_band/index.html b/ref/api/lfp/analysis/v1/lfp_band/index.html
diff --git a/ref/api/lfp/lfp_electrode/index.html b/ref/api/lfp/lfp_electrode/index.html
diff --git a/ref/api/lfp/lfp_imported/index.html b/ref/api/lfp/lfp_imported/index.html
diff --git a/ref/api/lfp/lfp_merge/index.html b/ref/api/lfp/lfp_merge/index.html
diff --git a/ref/api/lfp/v1/lfp/index.html b/ref/api/lfp/v1/lfp/index.html
diff --git a/ref/api/lfp/v1/lfp_artifact/index.html b/ref/api/lfp/v1/lfp_artifact/index.html
diff --git a/ref/api/lfp/v1/lfp_artifact_MAD_detection/index.html b/ref/api/lfp/v1/lfp_artifact_MAD_detection/index.html
diff --git a/ref/api/lfp/v1/lfp_artifact_difference_detection/index.html b/ref/api/lfp/v1/lfp_artifact_difference_detection/index.html
diff --git a/ref/api/linearization/merge/index.html b/ref/api/linearization/merge/index.html
diff --git a/ref/api/linearization/v0/main/index.html b/ref/api/linearization/v0/main/index.html
diff --git a/ref/api/linearization/v1/main/index.html b/ref/api/linearization/v1/main/index.html
diff --git a/ref/api/lock/file_lock/index.html b/ref/api/lock/file_lock/index.html
diff --git a/ref/api/make_pages.py b/ref/api/make_pages.py
@@ -0,0 +1,34 @@
+"""Generate the api pages and navigation.
+"""
+
+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/spyglass/").glob("**/*.py")):
+    if path.stem in ignored_stems or "cython" in path.stem:
+        continue
+    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[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
+
+
+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())