{
  "module": "docforge.renderers.base",
  "content": {
    "path": "docforge.renderers.base",
    "docstring": "# Summary\n\nRenderer base interfaces and configuration models.\n\nThis module defines the base protocol and configuration container used by\ndoc-forge renderers. Concrete renderer implementations should implement the\n`DocRenderer` protocol.",
    "objects": {
      "Project": {
        "name": "Project",
        "kind": "class",
        "path": "docforge.renderers.base.Project",
        "signature": "Project(name: str)",
        "docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n    name (str):\n        Name of the project.\n\n    modules (dict[str, Module]):\n        Mapping of module paths to `Module` instances.",
        "members": {
          "name": {
            "name": "name",
            "kind": "attribute",
            "path": "docforge.renderers.base.Project.name",
            "signature": null,
            "docstring": null
          },
          "modules": {
            "name": "modules",
            "kind": "attribute",
            "path": "docforge.renderers.base.Project.modules",
            "signature": null,
            "docstring": null
          },
          "add_module": {
            "name": "add_module",
            "kind": "function",
            "path": "docforge.renderers.base.Project.add_module",
            "signature": "add_module(module: Module)",
            "docstring": "Register a module in the project.\n\nArgs:\n    module (Module):\n        Module instance to add to the project."
          },
          "get_module": {
            "name": "get_module",
            "kind": "function",
            "path": "docforge.renderers.base.Project.get_module",
            "signature": "get_module(path: str)",
            "docstring": "Retrieve a module by its dotted path.\n\nArgs:\n    path (str):\n        Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n    Module:\n        The corresponding `Module` instance.\n\nRaises:\n    KeyError:\n        If the module does not exist in the project."
          },
          "get_all_modules": {
            "name": "get_all_modules",
            "kind": "function",
            "path": "docforge.renderers.base.Project.get_all_modules",
            "signature": "get_all_modules()",
            "docstring": "Return all modules contained in the project.\n\nReturns:\n    Iterable[Module]:\n        An iterable of `Module` instances."
          },
          "get_module_list": {
            "name": "get_module_list",
            "kind": "function",
            "path": "docforge.renderers.base.Project.get_module_list",
            "signature": "get_module_list()",
            "docstring": "Return the list of module import paths.\n\nReturns:\n    list[str]:\n        A list containing the dotted paths of all modules in the project."
          }
        }
      },
      "RendererConfig": {
        "name": "RendererConfig",
        "kind": "class",
        "path": "docforge.renderers.base.RendererConfig",
        "signature": "RendererConfig(out_dir: Path, project: Project)",
        "docstring": "Configuration container for documentation renderers.\n\nA `RendererConfig` instance groups together the project model and the\noutput directory used during rendering.\n\nAttributes:\n    out_dir (Path):\n        Directory where generated documentation files will be written.\n\n    project (Project):\n        Documentation project model 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": null,
        "docstring": "Protocol defining the interface for documentation renderers.\n\nImplementations of this protocol are responsible for transforming a\n`Project` model into renderer-specific documentation sources.",
        "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": "generate_sources(project: Project, out_dir: Path) -> None",
            "docstring": "Generate renderer-specific documentation sources.\n\nArgs:\n    project (Project):\n        Project model containing modules and documentation objects.\n\n    out_dir (Path):\n        Directory where generated documentation sources should be written."
          }
        }
      }
    }
  }
}