vibe-coding auto-creation of documentation pages

Author: gvwilson

mkdocs.yml

@@ -4,6 +4,9 @@ site_dir: docs
 
 plugins:
   - search
+  - gen-files:
+      scripts:
+        - scripts/gen_ref_pages.py
   - mkdocstrings:
       handlers:
         python:
@@ -16,10 +19,7 @@ plugins:
 
 nav:
 - Home: index.md
-- API Reference:
-  - plotly: reference/plotly.md
-  - plotly.graph_objects: reference/graph_objects.md
-  - plotly.express: reference/express.md
+- API Reference: reference/
 - Project:
   - license.md
   - conduct.md

pages/reference/express.md

@@ -54,7 +54,8 @@ dev_build = [
     "markdown-include",
     "mkdocs",
     "mkdocs-material",
-    "mkdocstrings[python]"
+    "mkdocstrings[python]",
+    "mkdocs-gen-files"
 ]
 dev_optional = [
     "plotly[dev_build]",

pages/reference/graph_objects.md

@@ -0,0 +1,32 @@
+"""Generate the code reference pages and navigation."""
+
+from pathlib import Path
+import mkdocs_gen_files
+
+nav = mkdocs_gen_files.Nav()
+
+for path in sorted(Path("plotly").rglob("*.py")):
+    module_path = path.relative_to(".").with_suffix("")
+    doc_path = path.relative_to(".").with_suffix(".md")
+    full_doc_path = Path("reference", doc_path)
+
+    parts = tuple(module_path.parts)
+
+    if parts[-1] == "__init__":
+        parts = parts[:-1]
+        doc_path = doc_path.with_name("index.md")
+        full_doc_path = full_doc_path.with_name("index.md")
+    elif parts[-1] == "__main__":
+        continue
+
+    nav[parts] = doc_path.as_posix()
+
+    with mkdocs_gen_files.open(full_doc_path, "w") as fd:
+        ident = ".".join(parts)
+        fd.write(f"# {ident}\n\n")
+        fd.write(f"::: {ident}")
+
+    mkdocs_gen_files.set_edit_path(full_doc_path, path)
+
+with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file:
+    nav_file.writelines(nav.build_literate_nav())