Mkdocs Renderer

docforge.renderers.mkdocs_renderer

MkDocsRenderer

Generates Markdown source files compatible with MkDocs Material and mkdocstrings, ensuring:

• Root index.md always exists
• Parent package indexes are created automatically
• Child modules are linked in parent index files

MkDocsRenderer

Renderer that generates Markdown source files formatted for the MkDocs 'mkdocstrings' plugin.

generate_sources

generate_sources(project: Project, out_dir: Path, module_is_source: bool | None = None) -> None

Produce a set of Markdown files in the output directory based on the provided Project models.

Parameters:

Name	Type	Description	Default
project	Project	The project models to render.	required
out_dir	Path	Target directory for documentation files.	required
module_is_source	bool | None	Module is the source folder and to be treated as the root folder.	None