This commit is contained in:
@@ -1,3 +1,22 @@
|
||||
"""
|
||||
# Renderers Layer
|
||||
|
||||
The `docforge.renderers` package handles the transformation of the internal
|
||||
documentation model 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 import MkDocsRenderer
|
||||
|
||||
__all__ = [
|
||||
|
||||
Reference in New Issue
Block a user