updated doc strings
This commit is contained in:
@@ -1,20 +1,28 @@
|
||||
"""
|
||||
# Renderers Layer
|
||||
Renderers layer for doc-forge.
|
||||
|
||||
The `docforge.renderers` package handles the transformation of the internal
|
||||
documentation models into physical files formatted for specific documentation
|
||||
engines.
|
||||
The ``docforge.renderers`` package transforms the internal documentation
|
||||
models into files formatted for specific documentation systems.
|
||||
|
||||
## Current Implementations
|
||||
Overview
|
||||
--------
|
||||
|
||||
- **MkDocsRenderer**: Generates Markdown files utilizing the `mkdocstrings`
|
||||
syntax. It automatically handles package/module hierarchy and generates
|
||||
`index.md` files for packages.
|
||||
Renderers consume the doc-forge project model and generate output suitable
|
||||
for documentation tools or machine interfaces.
|
||||
|
||||
## Extending
|
||||
Current implementations:
|
||||
|
||||
To add a new renderer, implement the `DocRenderer` protocol defined in
|
||||
`docforge.renderers.base`.
|
||||
- **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
|
||||
|
||||
Reference in New Issue
Block a user