updated docs strings and added README.md
This commit is contained in:
@@ -1,13 +1,14 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Model layer for doc-forge.
|
||||
|
||||
The ``docforge.models`` package defines the core data structures used to
|
||||
The `docforge.models` package defines the core data structures used to
|
||||
represent Python source code as a structured documentation model.
|
||||
|
||||
---
|
||||
|
||||
Overview
|
||||
--------
|
||||
# Overview
|
||||
|
||||
The model layer forms the central intermediate representation used throughout
|
||||
doc-forge. Python modules and objects discovered during introspection are
|
||||
|
||||
Reference in New Issue
Block a user