{
  "module": "docforge.models",
  "content": {
    "path": "docforge.models",
    "docstring": "# Model Layer\n\nThe `docforge.models` package provides the core data structures used to represent\nPython source code in a documentation-focused hierarchy.\n\n## Key Components\n\n- **Project**: The root container for all documented modules.\n- **Module**: Represents a Python module or package, containing members.\n- **DocObject**: A recursive structure for classes, functions, and attributes.\n\nThese classes are designed to be renderer-agnostic, allowing the same internal\nrepresentation to be transformed into various output formats (currently MkDocs).",
    "objects": {
      "Project": {
        "name": "Project",
        "kind": "class",
        "path": "docforge.models.Project",
        "signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.project.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.models.Project.name",
            "signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
            "docstring": null
          },
          "modules": {
            "name": "modules",
            "kind": "attribute",
            "path": "docforge.models.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.models.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.models.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.models.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.models.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."
          }
        }
      },
      "Module": {
        "name": "Module",
        "kind": "class",
        "path": "docforge.models.Module",
        "signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.module.Module')>",
        "docstring": "Represents a documented Python module or package.\n\nAttributes:\n    path: Dotted import path of the module.\n    docstring: Module-level docstring content.\n    members: Dictionary mapping object names to their DocObject representations.",
        "members": {
          "path": {
            "name": "path",
            "kind": "attribute",
            "path": "docforge.models.Module.path",
            "signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
            "docstring": null
          },
          "docstring": {
            "name": "docstring",
            "kind": "attribute",
            "path": "docforge.models.Module.docstring",
            "signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
            "docstring": null
          },
          "members": {
            "name": "members",
            "kind": "attribute",
            "path": "docforge.models.Module.members",
            "signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
            "docstring": null
          },
          "add_object": {
            "name": "add_object",
            "kind": "function",
            "path": "docforge.models.Module.add_object",
            "signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
            "docstring": "Add a documented object to the module.\n\nArgs:\n    obj: The object to add."
          },
          "get_object": {
            "name": "get_object",
            "kind": "function",
            "path": "docforge.models.Module.get_object",
            "signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
            "docstring": "Retrieve a member object by name.\n\nArgs:\n    name: The name of the object.\n\nReturns:\n    The requested DocObject."
          },
          "get_all_objects": {
            "name": "get_all_objects",
            "kind": "function",
            "path": "docforge.models.Module.get_all_objects",
            "signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
            "docstring": "Get all top-level objects in the module.\n\nReturns:\n    An iterable of DocObject instances."
          }
        }
      },
      "DocObject": {
        "name": "DocObject",
        "kind": "class",
        "path": "docforge.models.DocObject",
        "signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.object.DocObject')>",
        "docstring": "Represents a documented Python object (class, function, method, etc.).\n\nAttributes:\n    name: Local name of the object.\n    kind: Type of object (e.g., 'class', 'function', 'attribute').\n    path: Full dotted import path to the object.\n    signature: Callable signature, if applicable.\n    docstring: Raw docstring content extracted from the source.\n    members: Dictionary mapping member names to their DocObject representations.",
        "members": {
          "name": {
            "name": "name",
            "kind": "attribute",
            "path": "docforge.models.DocObject.name",
            "signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
            "docstring": null
          },
          "kind": {
            "name": "kind",
            "kind": "attribute",
            "path": "docforge.models.DocObject.kind",
            "signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
            "docstring": null
          },
          "path": {
            "name": "path",
            "kind": "attribute",
            "path": "docforge.models.DocObject.path",
            "signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
            "docstring": null
          },
          "signature": {
            "name": "signature",
            "kind": "attribute",
            "path": "docforge.models.DocObject.signature",
            "signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
            "docstring": null
          },
          "docstring": {
            "name": "docstring",
            "kind": "attribute",
            "path": "docforge.models.DocObject.docstring",
            "signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
            "docstring": null
          },
          "members": {
            "name": "members",
            "kind": "attribute",
            "path": "docforge.models.DocObject.members",
            "signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
            "docstring": null
          },
          "add_member": {
            "name": "add_member",
            "kind": "function",
            "path": "docforge.models.DocObject.add_member",
            "signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
            "docstring": "Add a child member to this object (e.g., a method to a class).\n\nArgs:\n    obj: The child DocObject to add."
          },
          "get_member": {
            "name": "get_member",
            "kind": "function",
            "path": "docforge.models.DocObject.get_member",
            "signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
            "docstring": "Retrieve a child member by name.\n\nArgs:\n    name: The name of the member.\n\nReturns:\n    The requested DocObject."
          },
          "get_all_members": {
            "name": "get_all_members",
            "kind": "function",
            "path": "docforge.models.DocObject.get_all_members",
            "signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
            "docstring": "Get all members of this object.\n\nReturns:\n    An iterable of child DocObject instances."
          }
        }
      },
      "module": {
        "name": "module",
        "kind": "module",
        "path": "docforge.models.module",
        "signature": null,
        "docstring": "This module defines the Module class, which represents a Python module or package\nin the doc-forge documentation models. It acts as a container for top-level\ndocumented objects.",
        "members": {
          "Dict": {
            "name": "Dict",
            "kind": "alias",
            "path": "docforge.models.module.Dict",
            "signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
            "docstring": null
          },
          "Iterable": {
            "name": "Iterable",
            "kind": "alias",
            "path": "docforge.models.module.Iterable",
            "signature": "<bound method Alias.signature of Alias('Iterable', 'typing.Iterable')>",
            "docstring": null
          },
          "Optional": {
            "name": "Optional",
            "kind": "alias",
            "path": "docforge.models.module.Optional",
            "signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
            "docstring": null
          },
          "DocObject": {
            "name": "DocObject",
            "kind": "class",
            "path": "docforge.models.module.DocObject",
            "signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.object.DocObject')>",
            "docstring": "Represents a documented Python object (class, function, method, etc.).\n\nAttributes:\n    name: Local name of the object.\n    kind: Type of object (e.g., 'class', 'function', 'attribute').\n    path: Full dotted import path to the object.\n    signature: Callable signature, if applicable.\n    docstring: Raw docstring content extracted from the source.\n    members: Dictionary mapping member names to their DocObject representations.",
            "members": {
              "name": {
                "name": "name",
                "kind": "attribute",
                "path": "docforge.models.module.DocObject.name",
                "signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
                "docstring": null
              },
              "kind": {
                "name": "kind",
                "kind": "attribute",
                "path": "docforge.models.module.DocObject.kind",
                "signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
                "docstring": null
              },
              "path": {
                "name": "path",
                "kind": "attribute",
                "path": "docforge.models.module.DocObject.path",
                "signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
                "docstring": null
              },
              "signature": {
                "name": "signature",
                "kind": "attribute",
                "path": "docforge.models.module.DocObject.signature",
                "signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
                "docstring": null
              },
              "docstring": {
                "name": "docstring",
                "kind": "attribute",
                "path": "docforge.models.module.DocObject.docstring",
                "signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
                "docstring": null
              },
              "members": {
                "name": "members",
                "kind": "attribute",
                "path": "docforge.models.module.DocObject.members",
                "signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
                "docstring": null
              },
              "add_member": {
                "name": "add_member",
                "kind": "function",
                "path": "docforge.models.module.DocObject.add_member",
                "signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
                "docstring": "Add a child member to this object (e.g., a method to a class).\n\nArgs:\n    obj: The child DocObject to add."
              },
              "get_member": {
                "name": "get_member",
                "kind": "function",
                "path": "docforge.models.module.DocObject.get_member",
                "signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
                "docstring": "Retrieve a child member by name.\n\nArgs:\n    name: The name of the member.\n\nReturns:\n    The requested DocObject."
              },
              "get_all_members": {
                "name": "get_all_members",
                "kind": "function",
                "path": "docforge.models.module.DocObject.get_all_members",
                "signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
                "docstring": "Get all members of this object.\n\nReturns:\n    An iterable of child DocObject instances."
              }
            }
          },
          "Module": {
            "name": "Module",
            "kind": "class",
            "path": "docforge.models.module.Module",
            "signature": "<bound method Class.signature of Class('Module', 12, 66)>",
            "docstring": "Represents a documented Python module or package.\n\nAttributes:\n    path: Dotted import path of the module.\n    docstring: Module-level docstring content.\n    members: Dictionary mapping object names to their DocObject representations.",
            "members": {
              "path": {
                "name": "path",
                "kind": "attribute",
                "path": "docforge.models.module.Module.path",
                "signature": null,
                "docstring": null
              },
              "docstring": {
                "name": "docstring",
                "kind": "attribute",
                "path": "docforge.models.module.Module.docstring",
                "signature": null,
                "docstring": null
              },
              "members": {
                "name": "members",
                "kind": "attribute",
                "path": "docforge.models.module.Module.members",
                "signature": null,
                "docstring": null
              },
              "add_object": {
                "name": "add_object",
                "kind": "function",
                "path": "docforge.models.module.Module.add_object",
                "signature": "<bound method Function.signature of Function('add_object', 38, 45)>",
                "docstring": "Add a documented object to the module.\n\nArgs:\n    obj: The object to add."
              },
              "get_object": {
                "name": "get_object",
                "kind": "function",
                "path": "docforge.models.module.Module.get_object",
                "signature": "<bound method Function.signature of Function('get_object', 47, 57)>",
                "docstring": "Retrieve a member object by name.\n\nArgs:\n    name: The name of the object.\n\nReturns:\n    The requested DocObject."
              },
              "get_all_objects": {
                "name": "get_all_objects",
                "kind": "function",
                "path": "docforge.models.module.Module.get_all_objects",
                "signature": "<bound method Function.signature of Function('get_all_objects', 59, 66)>",
                "docstring": "Get all top-level objects in the module.\n\nReturns:\n    An iterable of DocObject instances."
              }
            }
          }
        }
      },
      "object": {
        "name": "object",
        "kind": "module",
        "path": "docforge.models.object",
        "signature": null,
        "docstring": "This module defines the DocObject class, the fundamental recursive unit of the\ndoc-forge documentation models. A DocObject represents a single Python entity\n(class, function, method, or attribute) and its nested members.",
        "members": {
          "Dict": {
            "name": "Dict",
            "kind": "alias",
            "path": "docforge.models.object.Dict",
            "signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
            "docstring": null
          },
          "Iterable": {
            "name": "Iterable",
            "kind": "alias",
            "path": "docforge.models.object.Iterable",
            "signature": "<bound method Alias.signature of Alias('Iterable', 'typing.Iterable')>",
            "docstring": null
          },
          "Optional": {
            "name": "Optional",
            "kind": "alias",
            "path": "docforge.models.object.Optional",
            "signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
            "docstring": null
          },
          "DocObject": {
            "name": "DocObject",
            "kind": "class",
            "path": "docforge.models.object.DocObject",
            "signature": "<bound method Class.signature of Class('DocObject', 10, 76)>",
            "docstring": "Represents a documented Python object (class, function, method, etc.).\n\nAttributes:\n    name: Local name of the object.\n    kind: Type of object (e.g., 'class', 'function', 'attribute').\n    path: Full dotted import path to the object.\n    signature: Callable signature, if applicable.\n    docstring: Raw docstring content extracted from the source.\n    members: Dictionary mapping member names to their DocObject representations.",
            "members": {
              "name": {
                "name": "name",
                "kind": "attribute",
                "path": "docforge.models.object.DocObject.name",
                "signature": null,
                "docstring": null
              },
              "kind": {
                "name": "kind",
                "kind": "attribute",
                "path": "docforge.models.object.DocObject.kind",
                "signature": null,
                "docstring": null
              },
              "path": {
                "name": "path",
                "kind": "attribute",
                "path": "docforge.models.object.DocObject.path",
                "signature": null,
                "docstring": null
              },
              "signature": {
                "name": "signature",
                "kind": "attribute",
                "path": "docforge.models.object.DocObject.signature",
                "signature": null,
                "docstring": null
              },
              "docstring": {
                "name": "docstring",
                "kind": "attribute",
                "path": "docforge.models.object.DocObject.docstring",
                "signature": null,
                "docstring": null
              },
              "members": {
                "name": "members",
                "kind": "attribute",
                "path": "docforge.models.object.DocObject.members",
                "signature": null,
                "docstring": null
              },
              "add_member": {
                "name": "add_member",
                "kind": "function",
                "path": "docforge.models.object.DocObject.add_member",
                "signature": "<bound method Function.signature of Function('add_member', 48, 55)>",
                "docstring": "Add a child member to this object (e.g., a method to a class).\n\nArgs:\n    obj: The child DocObject to add."
              },
              "get_member": {
                "name": "get_member",
                "kind": "function",
                "path": "docforge.models.object.DocObject.get_member",
                "signature": "<bound method Function.signature of Function('get_member', 57, 67)>",
                "docstring": "Retrieve a child member by name.\n\nArgs:\n    name: The name of the member.\n\nReturns:\n    The requested DocObject."
              },
              "get_all_members": {
                "name": "get_all_members",
                "kind": "function",
                "path": "docforge.models.object.DocObject.get_all_members",
                "signature": "<bound method Function.signature of Function('get_all_members', 69, 76)>",
                "docstring": "Get all members of this object.\n\nReturns:\n    An iterable of child DocObject instances."
              }
            }
          }
        }
      },
      "project": {
        "name": "project",
        "kind": "module",
        "path": "docforge.models.project",
        "signature": null,
        "docstring": "This module defines the Project class, the top-level container for a documented\nproject. It aggregates multiple Module instances into a single named entity.",
        "members": {
          "Dict": {
            "name": "Dict",
            "kind": "alias",
            "path": "docforge.models.project.Dict",
            "signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
            "docstring": null
          },
          "Iterable": {
            "name": "Iterable",
            "kind": "alias",
            "path": "docforge.models.project.Iterable",
            "signature": "<bound method Alias.signature of Alias('Iterable', 'typing.Iterable')>",
            "docstring": null
          },
          "Module": {
            "name": "Module",
            "kind": "class",
            "path": "docforge.models.project.Module",
            "signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.module.Module')>",
            "docstring": "Represents a documented Python module or package.\n\nAttributes:\n    path: Dotted import path of the module.\n    docstring: Module-level docstring content.\n    members: Dictionary mapping object names to their DocObject representations.",
            "members": {
              "path": {
                "name": "path",
                "kind": "attribute",
                "path": "docforge.models.project.Module.path",
                "signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
                "docstring": null
              },
              "docstring": {
                "name": "docstring",
                "kind": "attribute",
                "path": "docforge.models.project.Module.docstring",
                "signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
                "docstring": null
              },
              "members": {
                "name": "members",
                "kind": "attribute",
                "path": "docforge.models.project.Module.members",
                "signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
                "docstring": null
              },
              "add_object": {
                "name": "add_object",
                "kind": "function",
                "path": "docforge.models.project.Module.add_object",
                "signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
                "docstring": "Add a documented object to the module.\n\nArgs:\n    obj: The object to add."
              },
              "get_object": {
                "name": "get_object",
                "kind": "function",
                "path": "docforge.models.project.Module.get_object",
                "signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
                "docstring": "Retrieve a member object by name.\n\nArgs:\n    name: The name of the object.\n\nReturns:\n    The requested DocObject."
              },
              "get_all_objects": {
                "name": "get_all_objects",
                "kind": "function",
                "path": "docforge.models.project.Module.get_all_objects",
                "signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
                "docstring": "Get all top-level objects in the module.\n\nReturns:\n    An iterable of DocObject instances."
              }
            }
          },
          "Project": {
            "name": "Project",
            "kind": "class",
            "path": "docforge.models.project.Project",
            "signature": "<bound method Class.signature of Class('Project', 11, 67)>",
            "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.models.project.Project.name",
                "signature": null,
                "docstring": null
              },
              "modules": {
                "name": "modules",
                "kind": "attribute",
                "path": "docforge.models.project.Project.modules",
                "signature": null,
                "docstring": null
              },
              "add_module": {
                "name": "add_module",
                "kind": "function",
                "path": "docforge.models.project.Project.add_module",
                "signature": "<bound method Function.signature of Function('add_module', 30, 37)>",
                "docstring": "Add a module to the project.\n\nArgs:\n    module: The module to add."
              },
              "get_module": {
                "name": "get_module",
                "kind": "function",
                "path": "docforge.models.project.Project.get_module",
                "signature": "<bound method Function.signature of Function('get_module', 39, 49)>",
                "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.models.project.Project.get_all_modules",
                "signature": "<bound method Function.signature of Function('get_all_modules', 51, 58)>",
                "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.models.project.Project.get_module_list",
                "signature": "<bound method Function.signature of Function('get_module_list', 60, 67)>",
                "docstring": "Get the list of all module dotted paths.\n\nReturns:\n    A list of module paths."
              }
            }
          }
        }
      }
    }
  }
}