updated doc strings
This commit is contained in:
@@ -1,17 +1,23 @@
|
||||
"""
|
||||
# Loader Layer
|
||||
Loader layer for doc-forge.
|
||||
|
||||
The `docforge.loaders` package is responsible for discovering Python source files
|
||||
and extracting their documentation using static analysis.
|
||||
The ``docforge.loaders`` package is responsible for discovering Python modules
|
||||
and extracting documentation data using static analysis.
|
||||
|
||||
## Core Features
|
||||
Overview
|
||||
--------
|
||||
|
||||
- **Discovery**: Automatically find all modules and packages in a project
|
||||
directory.
|
||||
- **Introspection**: Uses `griffe` to parse docstrings, signatures, and
|
||||
hierarchical relationships without executing the code.
|
||||
- **Filtering**: Automatically excludes private members (prefixed with `_`) to
|
||||
ensure clean public documentation.
|
||||
This layer converts Python source code into an intermediate documentation
|
||||
model used by doc-forge. It performs module discovery, introspection, and
|
||||
initial filtering before the data is passed to the core documentation models.
|
||||
|
||||
Core capabilities include:
|
||||
|
||||
- **Module discovery** – Locate Python modules and packages within a project.
|
||||
- **Static introspection** – Parse docstrings, signatures, and object
|
||||
hierarchies using the ``griffe`` library without executing the code.
|
||||
- **Public API filtering** – Exclude private members (names prefixed with
|
||||
``_``) to produce clean public documentation structures.
|
||||
"""
|
||||
|
||||
from .griffe_loader import GriffeLoader, discover_module_paths
|
||||
|
||||
Reference in New Issue
Block a user