docs(api): migrating the streaming utility to mkdocstrings

aws_lambda_powertools/utilities/streaming/__init__.py

@@ -1,3 +1,9 @@
+"""
+The streaming utility handles datasets larger than the available memory as streaming data.
+!!! abstract "Usage Documentation"
+    [`Streaming`](../utilities/streaming.md)
+"""
+
 from aws_lambda_powertools.utilities.streaming.s3_object import S3Object
 
 __all__ = ["S3Object"]

aws_lambda_powertools/utilities/typing/__init__.py

@@ -1,5 +1,7 @@
 """
 Typing for developer ease in the IDE
+!!! abstract "Usage Documentation"
+    [`Typing`](../utilities/typing.md)
 """
 
 from .lambda_context import LambdaContext

docs/api_doc/streaming.md

@@ -0,0 +1,5 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.streaming.s3_object
+::: aws_lambda_powertools.utilities.streaming.transformations.csv
+::: aws_lambda_powertools.utilities.streaming.transformations.gzip
+::: aws_lambda_powertools.utilities.streaming.transformations.zip

mkdocs.yml

@@ -63,6 +63,7 @@ nav:
           #     - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
           #     - Customer to advocate: contributing/tracks/customer_advocate.md
   - API Documentation:
+      - Streaming: api_doc/streaming.md
       - Typing: api_doc/typing.md
       - Validation: api_doc/validation.md