42 lines
1.1 KiB
Python
42 lines
1.1 KiB
Python
"""
|
||
# Summary
|
||
|
||
Model layer for doc-forge.
|
||
|
||
The `docforge.models` package defines the core data structures used to
|
||
represent Python source code as a structured documentation model.
|
||
|
||
---
|
||
|
||
# Overview
|
||
|
||
The model layer forms the central intermediate representation used throughout
|
||
doc-forge. Python modules and objects discovered during introspection are
|
||
converted into a hierarchy of documentation models that can later be rendered
|
||
into different documentation formats.
|
||
|
||
Key components:
|
||
|
||
- **Project** – Root container representing an entire documented codebase.
|
||
- **Module** – Representation of a Python module or package containing
|
||
documented members.
|
||
- **DocObject** – Recursive structure representing Python objects such as
|
||
classes, functions, methods, and attributes.
|
||
|
||
These models are intentionally **renderer-agnostic**, allowing the same
|
||
documentation structure to be transformed into multiple output formats
|
||
(e.g., MkDocs, MCP, or other renderers).
|
||
|
||
---
|
||
"""
|
||
|
||
from .project import Project
|
||
from .module import Module
|
||
from .object import DocObject
|
||
|
||
__all__ = [
|
||
"Project",
|
||
"Module",
|
||
"DocObject",
|
||
]
|