25 lines
597 B
Python
25 lines
597 B
Python
"""
|
|
# Renderers Layer
|
|
|
|
The `docforge.renderers` package handles the transformation of the internal
|
|
documentation models into physical files formatted for specific documentation
|
|
engines.
|
|
|
|
## Current Implementations
|
|
|
|
- **MkDocsRenderer**: Generates Markdown files utilizing the `mkdocstrings`
|
|
syntax. It automatically handles package/module hierarchy and generates
|
|
`index.md` files for packages.
|
|
|
|
## Extending
|
|
|
|
To add a new renderer, implement the `DocRenderer` protocol defined in
|
|
`docforge.renderers.base`.
|
|
"""
|
|
|
|
from .mkdocs_renderer import MkDocsRenderer
|
|
|
|
__all__ = [
|
|
"MkDocsRenderer",
|
|
]
|