docs(api): migrating the Middleware Factory utility to mkdocstrings (#6019)

leandrodamascena · sthulb · web-flow · commit 1c77dec8fe70 · 2025-02-04T10:18:39.000Z
* Mkdocstrings - Middleware Factory

* Mkdocstrings - Middleware Factory

---------

Co-authored-by: Simon Thulbourn &lt;sthulb@users.noreply.github.com&gt;
diff --git a/aws_lambda_powertools/middleware_factory/__init__.py b/aws_lambda_powertools/middleware_factory/__init__.py
@@ -1,4 +1,7 @@
-"""Utilities to enhance middlewares"""
+"""Utilities to enhance middleware
+!!! abstract "Usage Documentation"
+    [`Middleware Factory`](../utilities/middleware_factory.md)
+"""
 
 from .factory import lambda_handler_decorator
 
diff --git a/docs/api_doc/middleware_factory.md b/docs/api_doc/middleware_factory.md
@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.middleware_factory
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -86,6 +86,7 @@ nav:
           - Persistence: api_doc/idempotency/persistence.md
           - Serialization: api_doc/idempotency/serialization.md
       - JMESPath Functions: api_doc/jmespath_functions.md
+      - Middleware Factory: api_doc/middleware_factory.md
       - Parameters:
           - Base: api_doc/parameters/base.md
           - AppConfig: api_doc/parameters/appconfig.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<!-- markdownlint-disable MD043 MD041 -->`
	`2`	`+::: aws_lambda_powertools.middleware_factory`