feat(docs): in theory, added auto generating docs for the models

2023-12-19 05:54:49 -05:00 · 2023-12-19 05:54:49 -05:00 · 795ca60894
commit 795ca60894
parent 542bd06f09
7 changed files with 96 additions and 5 deletions
--- a/docs/source/api.rst
+++ b/docs/source/api.rst
@ -1,4 +1,4 @@
-API
+API Reference
 ===

 .. autosummary::
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@ -17,3 +17,4 @@ Contents

   usage
   api
+   models
--- a/docs/source/models.rst
+++ b/docs/source/models.rst
@ -0,0 +1,7 @@
+API Reference
+===
+
+.. automodule:: pyzipline.models
+    :members:
+    :undoc-members:
+    :show-inheritance: