41 lines
941 B
Python
41 lines
941 B
Python
"""
|
||
# Summary
|
||
|
||
Renderers layer for doc-forge.
|
||
|
||
The `docforge.renderers` package transforms the internal documentation
|
||
models into files formatted for specific documentation systems.
|
||
|
||
---
|
||
|
||
# Overview
|
||
|
||
Renderers consume the doc-forge project model and generate output suitable
|
||
for documentation tools or machine interfaces.
|
||
|
||
Current implementations:
|
||
|
||
- **MkDocsRenderer** – Produces Markdown files compatible with MkDocs and
|
||
the `mkdocstrings` plugin. It automatically handles package hierarchy
|
||
and generates `index.md` files for packages.
|
||
- **MCPRenderer** – Emits structured JSON resources designed for consumption
|
||
by Model Context Protocol (MCP) clients.
|
||
|
||
---
|
||
|
||
# Extending
|
||
|
||
New renderers can be added by implementing the `DocRenderer` protocol
|
||
defined in `docforge.renderers.base`.
|
||
|
||
---
|
||
"""
|
||
|
||
from .mkdocs_renderer import MkDocsRenderer
|
||
from .mcp_renderer import MCPRenderer
|
||
|
||
__all__ = [
|
||
"MkDocsRenderer",
|
||
"MCPRenderer",
|
||
]
|