This commit is contained in:
@@ -1,8 +1,17 @@
|
||||
"""
|
||||
Core documentation model for doc-forge.
|
||||
# Model Layer
|
||||
|
||||
These classes form the renderer-agnostic, introspection-derived
|
||||
representation of Python documentation.
|
||||
The `docforge.model` package provides the core data structures used to represent
|
||||
Python source code in a documentation-focused hierarchy.
|
||||
|
||||
## Key Components
|
||||
|
||||
- **Project**: The root container for all documented modules.
|
||||
- **Module**: Represents a Python module or package, containing members.
|
||||
- **DocObject**: A recursive structure for classes, functions, and attributes.
|
||||
|
||||
These classes are designed to be renderer-agnostic, allowing the same internal
|
||||
representation to be transformed into various output formats (currently MkDocs).
|
||||
"""
|
||||
|
||||
from .project import Project
|
||||
|
||||
Reference in New Issue
Block a user