added docs strings
All checks were successful
continuous-integration/drone/tag Build is passing

This commit is contained in:
2026-01-21 01:00:12 +05:30
parent 81e8a8cd49
commit b6e5114532
17 changed files with 563 additions and 25 deletions

View File

@@ -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