docs: nest generated docs under docs/lib and docs/mcp

docs/mcp/modules/docforge.nav.mkdocs.json

@@ -0,0 +1,69 @@
+{
+  "module": "docforge.nav.mkdocs",
+  "content": {
+    "path": "docforge.nav.mkdocs",
+    "docstring": "MkDocs navigation emitter.\n\nThis module provides the ``MkDocsNavEmitter`` class, which converts a\n``ResolvedNav`` instance into the navigation structure required by the\nMkDocs ``nav`` configuration.",
+    "objects": {
+      "Path": {
+        "name": "Path",
+        "kind": "alias",
+        "path": "docforge.nav.mkdocs.Path",
+        "signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
+        "docstring": null
+      },
+      "Any": {
+        "name": "Any",
+        "kind": "alias",
+        "path": "docforge.nav.mkdocs.Any",
+        "signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
+        "docstring": null
+      },
+      "ResolvedNav": {
+        "name": "ResolvedNav",
+        "kind": "class",
+        "path": "docforge.nav.mkdocs.ResolvedNav",
+        "signature": "<bound method Alias.signature of Alias('ResolvedNav', 'docforge.nav.resolver.ResolvedNav')>",
+        "docstring": "Resolved navigation structure.\n\nA ``ResolvedNav`` represents navigation data after glob patterns have been\nexpanded and paths validated against the filesystem.\n\nAttributes:\n    home: Relative path to the documentation home page.\n    groups: Mapping of navigation group titles to lists of resolved\n        documentation file paths.",
+        "members": {
+          "home": {
+            "name": "home",
+            "kind": "attribute",
+            "path": "docforge.nav.mkdocs.ResolvedNav.home",
+            "signature": "<bound method Alias.signature of Alias('home', 'docforge.nav.resolver.ResolvedNav.home')>",
+            "docstring": null
+          },
+          "groups": {
+            "name": "groups",
+            "kind": "attribute",
+            "path": "docforge.nav.mkdocs.ResolvedNav.groups",
+            "signature": "<bound method Alias.signature of Alias('groups', 'docforge.nav.resolver.ResolvedNav.groups')>",
+            "docstring": null
+          },
+          "all_files": {
+            "name": "all_files",
+            "kind": "function",
+            "path": "docforge.nav.mkdocs.ResolvedNav.all_files",
+            "signature": "<bound method Alias.signature of Alias('all_files', 'docforge.nav.resolver.ResolvedNav.all_files')>",
+            "docstring": "Iterate over all files referenced by the navigation structure.\n\nReturns:\n    An iterable of ``Path`` objects representing documentation files.\n\nRaises:\n    RuntimeError: If the home page is defined but the documentation\n        root is not available for resolution."
+          }
+        }
+      },
+      "MkDocsNavEmitter": {
+        "name": "MkDocsNavEmitter",
+        "kind": "class",
+        "path": "docforge.nav.mkdocs.MkDocsNavEmitter",
+        "signature": "<bound method Class.signature of Class('MkDocsNavEmitter', 15, 81)>",
+        "docstring": "Emit MkDocs navigation structures from resolved navigation data.\n\nThe emitter transforms a ``ResolvedNav`` object into the YAML-compatible\nlist structure expected by the MkDocs ``nav`` configuration field.",
+        "members": {
+          "emit": {
+            "name": "emit",
+            "kind": "function",
+            "path": "docforge.nav.mkdocs.MkDocsNavEmitter.emit",
+            "signature": "<bound method Function.signature of Function('emit', 23, 51)>",
+            "docstring": "Generate a navigation structure for ``mkdocs.yml``.\n\nArgs:\n    nav: Resolved navigation data describing documentation groups\n        and their associated Markdown files.\n\nReturns:\n    A list of dictionaries representing the MkDocs navigation layout.\n    Each dictionary maps a navigation label to a page or a list of\n    pages."
+          }
+        }
+      }
+    }
+  }
+}