Deployed 4011361 to 0.2 with MkDocs 1.6.0 and mike 2.1.1

datajoint · May 17, 2024 · df1ec13 · df1ec13
1 parent 4011361
commit df1ec13
Show file tree

Hide file tree

Showing 74 changed files with 19,712 additions and 145 deletions.
diff --git a/0.2/404.html b/0.2/404.html
diff --git a/0.2/CHANGELOG/index.html b/0.2/CHANGELOG/index.html
diff --git a/0.2/api/element_facemap/facemap_inference/index.html b/0.2/api/element_facemap/facemap_inference/index.html
diff --git a/0.2/api/element_facemap/facial_behavior_estimation/index.html b/0.2/api/element_facemap/facial_behavior_estimation/index.html
diff --git a/0.2/api/make_pages.py b/0.2/api/make_pages.py
@@ -0,0 +1,27 @@
+"""Generate the api pages and navigation.
+NOTE: Works best when following the Google style guide
+https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
+https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
+"""
+
+import mkdocs_gen_files
+from pathlib import Path
+import os
+
+package = os.getenv("PACKAGE")
+
+element = package.split("_", 1)[1]
+
+nav = mkdocs_gen_files.Nav()
+for path in sorted(Path(package).glob("**/*.py")):
+    if path.stem == "__init__" or path.stem == "version":
+        continue
+    with mkdocs_gen_files.open(f"api/{path.with_suffix('')}.md", "w") as f:
+        module_path = ".".join(
+            [p for p in path.with_suffix("").parts if p != "__init__"]
+        )
+        print(f"::: {module_path}", file=f)
+    nav[path.parts] = f"{path.with_suffix('')}.md"
+
+with mkdocs_gen_files.open("api/navigation.md", "w") as nav_file:
+    nav_file.writelines(nav.build_literate_nav())