updated docs strings and added README.md
This commit is contained in:
@@ -1,13 +1,14 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Loader layer for doc-forge.
|
||||
|
||||
The ``docforge.loaders`` package is responsible for discovering Python modules
|
||||
The `docforge.loaders` package is responsible for discovering Python modules
|
||||
and extracting documentation data using static analysis.
|
||||
|
||||
---
|
||||
|
||||
Overview
|
||||
--------
|
||||
# Overview
|
||||
|
||||
This layer converts Python source code into an intermediate documentation
|
||||
model used by doc-forge. It performs module discovery, introspection, and
|
||||
@@ -17,9 +18,9 @@ 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.
|
||||
hierarchies using the `griffe` library without executing the code.
|
||||
- **Public API filtering** – Exclude private members (names prefixed with
|
||||
``_``) to produce clean public documentation structures.
|
||||
`_`) to produce clean public documentation structures.
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user