updated doc strings
This commit is contained in:
@@ -1,17 +1,28 @@
|
||||
"""
|
||||
# Model Layer
|
||||
Model layer for doc-forge.
|
||||
|
||||
The `docforge.models` package provides the core data structures used to represent
|
||||
Python source code in a documentation-focused hierarchy.
|
||||
The ``docforge.models`` package defines the core data structures used to
|
||||
represent Python source code as a structured documentation model.
|
||||
|
||||
## Key Components
|
||||
Overview
|
||||
--------
|
||||
|
||||
- **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.
|
||||
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.
|
||||
|
||||
These classes are designed to be renderer-agnostic, allowing the same internal
|
||||
representation to be transformed into various output formats (currently MkDocs).
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user