Deployed 0d1e13c with MkDocs version: 1.6.1

Author: github-actions[bot]

.nojekyll

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Allen Institute for Neural Dynamics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

404.html

@@ -0,0 +1,125 @@
+#!/usr/bin/env uv run
+"""
+Script to regenerate the API documentation structure in mkdocs.yml
+based on the current state of the library.
+"""
+
+import logging
+import shutil
+from pathlib import Path
+
+import yaml
+
+# Constants
+ROOT_DIR = Path(__file__).parent.parent
+PACKAGE_NAME = "contraqctor"
+SRC_DIR = ROOT_DIR / "src" / f"{PACKAGE_NAME}"
+DOCS_DIR = ROOT_DIR / "docs"
+API_DIR = DOCS_DIR / "api"
+MKDOCS_YML = ROOT_DIR / "mkdocs.yml"
+API_LABEL = "API Reference"
+
+# Leaving this manual for now.
+DOCUMENTED_MODULES = ["contract", "qc"]
+TO_COPY = ["assets", "examples", "LICENSE"]
+log = logging.getLogger("mkdocs")
+
+
+def on_pre_build(config):
+    """Mkdocs pre-build hook."""
+    for file_or_dir in TO_COPY:
+        src = ROOT_DIR / file_or_dir
+        dest = DOCS_DIR / file_or_dir
+        if src.exists():
+            log.info(f"Copying {file_or_dir} to docs...")
+
+            if src.is_file():
+                print(f"Copying file {src} to {dest}")
+                shutil.copy(src, dest)
+            else:
+                if dest.exists():
+                    shutil.rmtree(dest)
+                shutil.copytree(src, dest)
+            log.info(f"{file_or_dir} copied successfully.")
+        else:
+            log.warning(f"Source: {file_or_dir} not found, skipping.")
+
+    main()
+
+
+def find_modules(base_dir, module_name):
+    """Find all Python modules in the given directory."""
+    modules = []
+    dir_path = base_dir / module_name
+
+    if not dir_path.is_dir():
+        return modules
+
+    if (dir_path / "__init__.py").exists():
+        modules.append(("core", f"{module_name}"))
+
+    for item in dir_path.iterdir():
+        if item.is_file() and item.suffix == ".py" and not item.name.startswith("_"):
+            modules.append((item.stem, f"{module_name}.{item.stem}"))
+
+    modules.sort(key=lambda x: x[0])
+
+    return modules
+
+
+def generate_api_structure():
+    """Generate the API documentation structure."""
+    api_structure = {}
+
+    for module_name in DOCUMENTED_MODULES:
+        module_structure = []
+        modules = find_modules(SRC_DIR, module_name)
+
+        for name, import_path in modules:
+            md_file = f"api/{module_name}/{name}.md"
+
+            (API_DIR / module_name).mkdir(parents=True, exist_ok=True)
+
+            with open(DOCS_DIR / md_file, "w") as f:
+                f.write(f"# {import_path}\n\n")
+                f.write(f"::: {PACKAGE_NAME}.{import_path}\n")
+
+            module_structure.append({name: md_file})
+
+        api_structure[module_name] = module_structure
+
+    return api_structure
+
+
+def update_mkdocs_yml(api_structure):
+    """Rewrite the mkdocs.yml overriding the API Reference section only!."""
+    with open(MKDOCS_YML, "r") as f:
+        config = yaml.safe_load(f)
+
+    nav = config.get("nav")
+    for entry in nav:
+        if isinstance(entry, dict) and API_LABEL in entry:
+            api_ref = ["api/index.md"]
+            for module_name, module_content in api_structure.items():
+                api_ref.append({module_name.capitalize(): module_content})
+            entry[API_LABEL] = api_ref
+
+    with open(MKDOCS_YML, "w+") as f:
+        yaml.dump(config, f, sort_keys=False, default_flow_style=False)
+
+
+def main():
+    """Main function."""
+    log.info("Regenerating API documentation...")
+
+    # Generate API structure
+    api_structure = generate_api_structure()
+
+    # Update mkdocs.yml
+    update_mkdocs_yml(api_structure)
+
+    log.info("API documentation regenerated successfully.")
+
+
+if __name__ == "__main__":
+    main()