33 lines
944 B
Python
33 lines
944 B
Python
"""
|
||
Loader layer for doc-forge.
|
||
|
||
The ``docforge.loaders`` package is responsible for discovering Python modules
|
||
and extracting documentation data using static analysis.
|
||
|
||
---
|
||
|
||
Overview
|
||
--------
|
||
|
||
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
|
||
|
||
__all__ = [
|
||
"GriffeLoader",
|
||
"discover_module_paths",
|
||
]
|