Base

docforge.renderers.base

This module defines the base interfaces and configuration containers for doc-forge renderers. All renderer implementations should adhere to the DocRenderer protocol.

DocRenderer

Bases: Protocol

Protocol defining the interface for documentation renderers.

generate_sources

generate_sources(project: Project, out_dir: Path) -> None

Generate renderer-specific source files for the given project.

Parameters:

Name	Type	Description	Default
project	Project	The project models containing modules and objects.	required
out_dir	Path	Target directory for the generated files.	required

RendererConfig

RendererConfig(out_dir: Path, project: Project)

Configuration container for documentation renderers.

Parameters:

Name	Type	Description	Default
out_dir	Path	The directory where documentation files should be written.	required
project	Project	The introspected project models to be rendered.	required