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.renderers.base.json
+++ b/mcp_docs/modules/docforge.renderers.base.json
@@ -0,0 +1,120 @@
+{
+  "module": "docforge.renderers.base",
+  "content": {
+    "path": "docforge.renderers.base",
+    "docstring": "This module defines the base interfaces and configuration containers for\ndoc-forge renderers. All renderer implementations should adhere to the\nDocRenderer protocol.",
+    "objects": {
+      "Path": {
+        "name": "Path",
+        "kind": "alias",
+        "path": "docforge.renderers.base.Path",
+        "signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
+        "docstring": null
+      },
+      "Protocol": {
+        "name": "Protocol",
+        "kind": "alias",
+        "path": "docforge.renderers.base.Protocol",
+        "signature": "<bound method Alias.signature of Alias('Protocol', 'typing.Protocol')>",
+        "docstring": null
+      },
+      "Project": {
+        "name": "Project",
+        "kind": "class",
+        "path": "docforge.renderers.base.Project",
+        "signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.Project')>",
+        "docstring": "Represents a documentation project, serving as a container for modules.\n\nAttributes:\n    name: Name of the project.\n    modules: Dictionary mapping module paths to Module instances.",
+        "members": {
+          "name": {
+            "name": "name",
+            "kind": "attribute",
+            "path": "docforge.renderers.base.Project.name",
+            "signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
+            "docstring": null
+          },
+          "modules": {
+            "name": "modules",
+            "kind": "attribute",
+            "path": "docforge.renderers.base.Project.modules",
+            "signature": "<bound method Alias.signature of Alias('modules', 'docforge.models.project.Project.modules')>",
+            "docstring": null
+          },
+          "add_module": {
+            "name": "add_module",
+            "kind": "function",
+            "path": "docforge.renderers.base.Project.add_module",
+            "signature": "<bound method Alias.signature of Alias('add_module', 'docforge.models.project.Project.add_module')>",
+            "docstring": "Add a module to the project.\n\nArgs:\n    module: The module to add."
+          },
+          "get_module": {
+            "name": "get_module",
+            "kind": "function",
+            "path": "docforge.renderers.base.Project.get_module",
+            "signature": "<bound method Alias.signature of Alias('get_module', 'docforge.models.project.Project.get_module')>",
+            "docstring": "Retrieve a module by its dotted path.\n\nArgs:\n    path: The dotted path of the module (e.g., 'pkg.mod').\n\nReturns:\n    The requested Module."
+          },
+          "get_all_modules": {
+            "name": "get_all_modules",
+            "kind": "function",
+            "path": "docforge.renderers.base.Project.get_all_modules",
+            "signature": "<bound method Alias.signature of Alias('get_all_modules', 'docforge.models.project.Project.get_all_modules')>",
+            "docstring": "Get all modules in the project.\n\nReturns:\n    An iterable of Module objects."
+          },
+          "get_module_list": {
+            "name": "get_module_list",
+            "kind": "function",
+            "path": "docforge.renderers.base.Project.get_module_list",
+            "signature": "<bound method Alias.signature of Alias('get_module_list', 'docforge.models.project.Project.get_module_list')>",
+            "docstring": "Get the list of all module dotted paths.\n\nReturns:\n    A list of module paths."
+          }
+        }
+      },
+      "RendererConfig": {
+        "name": "RendererConfig",
+        "kind": "class",
+        "path": "docforge.renderers.base.RendererConfig",
+        "signature": "<bound method Class.signature of Class('RendererConfig', 13, 24)>",
+        "docstring": "Configuration container for documentation renderers.\n\nArgs:\n    out_dir: The directory where documentation files should be written.\n    project: The introspected project models to be rendered.",
+        "members": {
+          "out_dir": {
+            "name": "out_dir",
+            "kind": "attribute",
+            "path": "docforge.renderers.base.RendererConfig.out_dir",
+            "signature": null,
+            "docstring": null
+          },
+          "project": {
+            "name": "project",
+            "kind": "attribute",
+            "path": "docforge.renderers.base.RendererConfig.project",
+            "signature": null,
+            "docstring": null
+          }
+        }
+      },
+      "DocRenderer": {
+        "name": "DocRenderer",
+        "kind": "class",
+        "path": "docforge.renderers.base.DocRenderer",
+        "signature": "<bound method Class.signature of Class('DocRenderer', 27, 46)>",
+        "docstring": "Protocol defining the interface for documentation renderers.",
+        "members": {
+          "name": {
+            "name": "name",
+            "kind": "attribute",
+            "path": "docforge.renderers.base.DocRenderer.name",
+            "signature": null,
+            "docstring": null
+          },
+          "generate_sources": {
+            "name": "generate_sources",
+            "kind": "function",
+            "path": "docforge.renderers.base.DocRenderer.generate_sources",
+            "signature": "<bound method Function.signature of Function('generate_sources', 34, 46)>",
+            "docstring": "Generate renderer-specific source files for the given project.\n\nArgs:\n    project: The project models containing modules and objects.\n    out_dir: Target directory for the generated files."
+          }
+        }
+      }
+    }
+  }
+}