added mcp_docs

2026-01-21 17:26:47 +05:30
parent f6a596ab62
commit f76d8ccce4
22 changed files with 6629 additions and 0 deletions
--- a/mcp_docs/modules/docforge.nav.spec.json
+++ b/mcp_docs/modules/docforge.nav.spec.json
@@ -0,0 +1,88 @@
+{
+  "module": "docforge.nav.spec",
+  "content": {
+    "path": "docforge.nav.spec",
+    "docstring": "This module defines the NavSpec class, which represents the user's intent for\ndocumentation navigation as defined in a YAML specification (usually\ndocforge.nav.yml).",
+    "objects": {
+      "Path": {
+        "name": "Path",
+        "kind": "alias",
+        "path": "docforge.nav.spec.Path",
+        "signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
+        "docstring": null
+      },
+      "Dict": {
+        "name": "Dict",
+        "kind": "alias",
+        "path": "docforge.nav.spec.Dict",
+        "signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
+        "docstring": null
+      },
+      "List": {
+        "name": "List",
+        "kind": "alias",
+        "path": "docforge.nav.spec.List",
+        "signature": "<bound method Alias.signature of Alias('List', 'typing.List')>",
+        "docstring": null
+      },
+      "Optional": {
+        "name": "Optional",
+        "kind": "alias",
+        "path": "docforge.nav.spec.Optional",
+        "signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
+        "docstring": null
+      },
+      "yaml": {
+        "name": "yaml",
+        "kind": "alias",
+        "path": "docforge.nav.spec.yaml",
+        "signature": "<bound method Alias.signature of Alias('yaml', 'yaml')>",
+        "docstring": null
+      },
+      "NavSpec": {
+        "name": "NavSpec",
+        "kind": "class",
+        "path": "docforge.nav.spec.NavSpec",
+        "signature": "<bound method Class.signature of Class('NavSpec', 13, 91)>",
+        "docstring": "Parsed representation of the docforge navigation specification file.\n\nAttributes:\n    home: Path to the home document (e.g., 'index.md').\n    groups: Mapping of group titles to lists of path patterns/globs.",
+        "members": {
+          "home": {
+            "name": "home",
+            "kind": "attribute",
+            "path": "docforge.nav.spec.NavSpec.home",
+            "signature": null,
+            "docstring": null
+          },
+          "groups": {
+            "name": "groups",
+            "kind": "attribute",
+            "path": "docforge.nav.spec.NavSpec.groups",
+            "signature": null,
+            "docstring": null
+          },
+          "load": {
+            "name": "load",
+            "kind": "function",
+            "path": "docforge.nav.spec.NavSpec.load",
+            "signature": "<bound method Function.signature of Function('load', 37, 77)>",
+            "docstring": "Load a NavSpec from a YAML file.\n\nArgs:\n    path: The filesystem path to the YAML file.\n\nReturns:\n    A NavSpec instance.\n\nRaises:\n    FileNotFoundError: If the path does not exist.\n    ValueError: If the file content is not a valid NavSpec mapping."
+          },
+          "all_patterns": {
+            "name": "all_patterns",
+            "kind": "function",
+            "path": "docforge.nav.spec.NavSpec.all_patterns",
+            "signature": "<bound method Function.signature of Function('all_patterns', 79, 91)>",
+            "docstring": "Get all path patterns referenced in the specification.\n\nReturns:\n    A list of all patterns (home plus all groups)."
+          }
+        }
+      },
+      "load_nav_spec": {
+        "name": "load_nav_spec",
+        "kind": "function",
+        "path": "docforge.nav.spec.load_nav_spec",
+        "signature": "<bound method Function.signature of Function('load_nav_spec', 94, 114)>",
+        "docstring": "Utility function to load a NavSpec from a file.\n\nArgs:\n    path: Path to the navigation specification file.\n\nReturns:\n    A loaded NavSpec instance."
+      }
+    }
+  }
+}