docs(api): migrating the validation utility to mkdocstrings

aws_lambda_powertools/utilities/validation/__init__.py

@@ -1,5 +1,7 @@
 """
 Simple validator to enforce incoming/outgoing event conforms with JSON Schema
+!!! abstract "Usage Documentation"
+    [`Validation`](../utilities/validation.md)
 """
 
 from .exceptions import (

aws_lambda_powertools/utilities/validation/exceptions.py

@@ -19,7 +19,7 @@ def __init__(
         rule: str | None = None,
         rule_definition: Any | None = None,
     ):
-        """
+        """When serialization fail schema validation
 
         Parameters
         ----------

docs/api_doc/validation.md

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

mkdocs.yml

@@ -62,6 +62,8 @@ nav:
           #     - Overview: contributing/tracks/overview.md
           #     - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
           #     - Customer to advocate: contributing/tracks/customer_advocate.md
+  - API Documentation:
+      - Validation: api_doc/validation.md
 
 theme:
   name: material
@@ -144,22 +146,19 @@ plugins:
           import:
             - https://docs.python.org/3/objects.inv
           options:
-            # General
-            allow_inspection: true
-            show_source: true
-            show_bases: true
             # Headings
-            heading_level: 2
-            #show_root_heading: false
+            #heading_level: 2
+            #show_root_heading: true
             #show_root_toc_entry: true
             #show_root_full_path: true
             #show_root_members_full_path: false
             #show_object_full_path: false
-            #show_category_heading: true
+            show_category_heading: false
             # Members
-            filters: ["!^_[^_]"]
+            filters: ["!^_"]
             group_by_category: true
-            show_submodules: false
+            members_order: alphabetical
+            show_submodules: true
             # Docstrings
             docstring_style: numpy
             docstring_options:
@@ -168,10 +167,10 @@ plugins:
             merge_init_into_class: true
             show_if_no_docstring: false
             # Signature
-            annotations_path: brief
             show_signature: true
             show_signature_annotations: true
             separate_signature: true
+            summary: true
 
 extra_css:
   - stylesheets/extra.css