docs(api): migrating the data masking utility to mkdocstrings

aws_lambda_powertools/utilities/data_masking/base.py

@@ -1,3 +1,9 @@
+"""
+Base class for Data Masking
+!!! abstract "Usage Documentation"
+    [`Data masking`](../../utilities/data_masking.md)
+"""
+
 from __future__ import annotations
 
 import functools
@@ -24,8 +30,9 @@ class DataMasking:
     The DataMasking class orchestrates erasing, encrypting, and decrypting
     for the base provider.
 
-    Example:
-    ```
+    Example
+    -------
+    ```python
     from aws_lambda_powertools.utilities.data_masking.base import DataMasking
 
     def lambda_handler(event, context):

aws_lambda_powertools/utilities/data_masking/provider/base.py

@@ -11,9 +11,9 @@ class BaseProvider:
     """
     The BaseProvider class serves as an abstract base class for data masking providers.
 
-    Examples
+    Example
     --------
-    ```
+    ```python
     from aws_lambda_powertools.utilities._data_masking.provider import BaseProvider
     from aws_lambda_powertools.utilities.data_masking import DataMasking
 

aws_lambda_powertools/utilities/data_masking/provider/kms/aws_encryption_sdk.py

@@ -48,9 +48,9 @@ class AWSEncryptionSDKProvider(BaseProvider):
     """
     The AWSEncryptionSDKProvider is used as a provider for the DataMasking class.
 
-    Usage
+    Example
     -------
-    ```
+    ```python
     from aws_lambda_powertools.utilities.data_masking import DataMasking
     from aws_lambda_powertools.utilities.data_masking.providers.kms.aws_encryption_sdk import (
         AWSEncryptionSDKProvider,

docs/api_doc/data_masking/base.md

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

docs/api_doc/data_masking/exceptions.md

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

docs/api_doc/data_masking/provider.md

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

mkdocs.yml

@@ -63,14 +63,18 @@ nav:
           #     - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
           #     - Customer to advocate: contributing/tracks/customer_advocate.md
   - API Documentation:
-      - Feature Flags: 
+      - Data Masking:
+          - Base: api_doc/data_masking/base.md
+          - Exception: api_doc/data_masking/exceptions.md
+          - Provider: api_doc/data_masking/provider.md
+      - Feature Flags:
           - AppConfig: api_doc/feature_flags/appconfig.md
           - Base: api_doc/feature_flags/base.md
           - Comparators: api_doc/feature_flags/comparators.md
           - Exceptions: api_doc/feature_flags/exceptions.md
           - Feature flags: api_doc/feature_flags/feature_flags.md
           - Schema: api_doc/feature_flags/schema.md
-      - Idempotency: 
+      - Idempotency:
           - Base: api_doc/idempotency/base.md
           - Config: api_doc/idempotency/config.md
           - Exceptions: api_doc/idempotency/exceptions.md