update doc

MacHu-GWU · MacHu-GWU · commit c2a16f07e7af · 2024-05-22T16:06:08.000-04:00
diff --git a/docs/source/02-Client-Side-Encryption/index.ipynb b/docs/source/02-Client-Side-Encryption/index.ipynb
diff --git a/docs/source/pynamodb_mate/__init__.rst b/docs/source/pynamodb_mate/__init__.rst
@@ -12,8 +12,10 @@ sub packages and modules
 
     attributes <attributes/__init__>
     patterns <patterns/__init__>
+    api <api>
     cipher <cipher>
     compat <compat>
     helpers <helpers>
     models <models>
+    type_hint <type_hint>
     
diff --git a/docs/source/pynamodb_mate/api.rst b/docs/source/pynamodb_mate/api.rst
@@ -0,0 +1,5 @@
+api
+===
+
+.. automodule:: pynamodb_mate.api
+    :members:
diff --git a/docs/source/pynamodb_mate/attributes/__init__.rst b/docs/source/pynamodb_mate/attributes/__init__.rst
@@ -10,6 +10,7 @@ sub packages and modules
 .. toctree::
     :maxdepth: 1
 
+    api <api>
     compressed <compressed>
     encrypted <encrypted>
     s3backed <s3backed>
diff --git a/docs/source/pynamodb_mate/attributes/api.rst b/docs/source/pynamodb_mate/attributes/api.rst
@@ -0,0 +1,5 @@
+api
+===
+
+.. automodule:: pynamodb_mate.attributes.api
+    :members:
diff --git a/docs/source/pynamodb_mate/patterns/__init__.rst b/docs/source/pynamodb_mate/patterns/__init__.rst
@@ -11,5 +11,8 @@ sub packages and modules
     :maxdepth: 1
 
     cache <cache/__init__>
+    large_attribute <large_attribute/__init__>
+    relationship <relationship/__init__>
     status_tracker <status_tracker/__init__>
+    api <api>
     
diff --git a/docs/source/pynamodb_mate/patterns/api.rst b/docs/source/pynamodb_mate/patterns/api.rst
@@ -0,0 +1,5 @@
+api
+===
+
+.. automodule:: pynamodb_mate.patterns.api
+    :members:
diff --git a/docs/source/pynamodb_mate/patterns/cache/__init__.rst b/docs/source/pynamodb_mate/patterns/cache/__init__.rst
@@ -12,6 +12,7 @@ sub packages and modules
 
     backend <backend/__init__>
     abstract <abstract>
+    api <api>
     multi_layer <multi_layer>
     utils <utils>
     
diff --git a/docs/source/pynamodb_mate/patterns/cache/api.rst b/docs/source/pynamodb_mate/patterns/cache/api.rst
@@ -0,0 +1,5 @@
+api
+===
+
+.. automodule:: pynamodb_mate.patterns.cache.api
+    :members:
diff --git a/docs/source/pynamodb_mate/patterns/large_attribute/__init__.rst b/docs/source/pynamodb_mate/patterns/large_attribute/__init__.rst
@@ -0,0 +1,15 @@
+large_attribute
+===============
+
+.. automodule:: pynamodb_mate.patterns.large_attribute
+    :members:
+
+sub packages and modules
+------------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    api <api>
+    impl <impl>
+    
diff --git a/docs/source/pynamodb_mate/patterns/large_attribute/api.rst b/docs/source/pynamodb_mate/patterns/large_attribute/api.rst
@@ -0,0 +1,5 @@
+api
+===
+
+.. automodule:: pynamodb_mate.patterns.large_attribute.api
+    :members:
diff --git a/docs/source/pynamodb_mate/patterns/large_attribute/impl.rst b/docs/source/pynamodb_mate/patterns/large_attribute/impl.rst
@@ -0,0 +1,5 @@
+impl
+====
+
+.. automodule:: pynamodb_mate.patterns.large_attribute.impl
+    :members:
diff --git a/docs/source/pynamodb_mate/patterns/relationship/__init__.rst b/docs/source/pynamodb_mate/patterns/relationship/__init__.rst
@@ -0,0 +1,15 @@
+relationship
+============
+
+.. automodule:: pynamodb_mate.patterns.relationship
+    :members:
+
+sub packages and modules
+------------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    api <api>
+    impl <impl>
+    
diff --git a/docs/source/pynamodb_mate/patterns/relationship/api.rst b/docs/source/pynamodb_mate/patterns/relationship/api.rst
@@ -0,0 +1,5 @@
+api
+===
+
+.. automodule:: pynamodb_mate.patterns.relationship.api
+    :members:
diff --git a/docs/source/pynamodb_mate/patterns/relationship/impl.rst b/docs/source/pynamodb_mate/patterns/relationship/impl.rst
@@ -0,0 +1,5 @@
+impl
+====
+
+.. automodule:: pynamodb_mate.patterns.relationship.impl
+    :members:
diff --git a/docs/source/pynamodb_mate/patterns/status_tracker/__init__.rst b/docs/source/pynamodb_mate/patterns/status_tracker/__init__.rst
@@ -10,5 +10,6 @@ sub packages and modules
 .. toctree::
     :maxdepth: 1
 
+    api <api>
     impl <impl>
     
diff --git a/docs/source/pynamodb_mate/patterns/status_tracker/api.rst b/docs/source/pynamodb_mate/patterns/status_tracker/api.rst
@@ -0,0 +1,5 @@
+api
+===
+
+.. automodule:: pynamodb_mate.patterns.status_tracker.api
+    :members:
diff --git a/docs/source/pynamodb_mate/type_hint.rst b/docs/source/pynamodb_mate/type_hint.rst
@@ -0,0 +1,5 @@
+type_hint
+=========
+
+.. automodule:: pynamodb_mate.type_hint
+    :members:
