docs(api): migrating the idempotency utility to mkdocstrings (#6007)

Mkdocstrings - Idempotency module

Author: leandrodamascena

aws_lambda_powertools/utilities/idempotency/base.py

@@ -1,3 +1,9 @@
+"""
+Base for Idempotency utility
+!!! abstract "Usage Documentation"
+    [`Idempotency`](../../utilities/idempotency.md)
+"""
+
 from __future__ import annotations
 
 import datetime

aws_lambda_powertools/utilities/idempotency/idempotency.py

@@ -61,20 +61,20 @@ def idempotent(
     key_prefix: str | Optional
         Custom prefix for idempotency key: key_prefix#hash
 
-    Examples
+    Example
     --------
     **Processes Lambda's event in an idempotent manner**
 
-        >>> from aws_lambda_powertools.utilities.idempotency import (
-        >>>    idempotent, DynamoDBPersistenceLayer, IdempotencyConfig
-        >>> )
-        >>>
-        >>> idem_config=IdempotencyConfig(event_key_jmespath="body")
-        >>> persistence_layer = DynamoDBPersistenceLayer(table_name="idempotency_store")
-        >>>
-        >>> @idempotent(config=idem_config, persistence_store=persistence_layer)
-        >>> def handler(event, context):
-        >>>     return {"StatusCode": 200}
+        from aws_lambda_powertools.utilities.idempotency import (
+           idempotent, DynamoDBPersistenceLayer, IdempotencyConfig
+        )
+
+        idem_config=IdempotencyConfig(event_key_jmespath="body")
+        persistence_layer = DynamoDBPersistenceLayer(table_name="idempotency_store")
+
+        @idempotent(config=idem_config, persistence_store=persistence_layer)
+        def handler(event, context):
+            return {"StatusCode": 200}
     """
 
     # Skip idempotency controls when POWERTOOLS_IDEMPOTENCY_DISABLED has a truthy value
@@ -136,7 +136,7 @@ def idempotent_function(
     key_prefix: str | Optional
         Custom prefix for idempotency key: key_prefix#hash
 
-    Examples
+    Example
     --------
     **Processes an order in an idempotent manner**
 

aws_lambda_powertools/utilities/idempotency/persistence/dynamodb.py

@@ -76,7 +76,7 @@ def __init__(
         boto3_client : DynamoDBClient, optional
             Boto3 DynamoDB Client to use, boto3_session and boto_config will be ignored if both are provided
 
-        Examples
+        Example
         --------
         **Create a DynamoDB persistence layer with custom settings**
 

aws_lambda_powertools/utilities/idempotency/persistence/redis.py

@@ -112,7 +112,7 @@ def __init__(
         ssl: bool, optional: default True
             set whether to use ssl for Redis connection
 
-        Examples
+        Example
         --------
 
         ```python

aws_lambda_powertools/utilities/parameters/base.py

@@ -1,7 +1,7 @@
 """
 Base for Parameter providers
 !!! abstract "Usage Documentation"
-    [`Parameters`](../utilities/parameters.md)
+    [`Parameters`](../../utilities/parameters.md)
 """
 
 from __future__ import annotations

docs/api_doc/idempotency/base.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.idempotency.base

docs/api_doc/idempotency/config.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.idempotency.config

docs/api_doc/idempotency/exceptions.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.idempotency.exceptions

docs/api_doc/idempotency/persistence.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.idempotency.persistence

docs/api_doc/idempotency/serialization.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.idempotency.serialization

mkdocs.yml

@@ -63,6 +63,12 @@ nav:
           #     - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
           #     - Customer to advocate: contributing/tracks/customer_advocate.md
   - API Documentation:
+      - Idempotency: 
+          - Base: api_doc/idempotency/base.md
+          - Config: api_doc/idempotency/config.md
+          - Exceptions: api_doc/idempotency/exceptions.md
+          - Persistence: api_doc/idempotency/persistence.md
+          - Serialization: api_doc/idempotency/serialization.md
       - JMESPath Functions: api_doc/jmespath_functions.md
       - Parameters:
           - Base: api_doc/parameters/base.md