docs(api): migrating the Middleware Factory utility to mkdocstrings (a…

…ws-powertools#6019) * Mkdocstrings - Middleware Factory * Mkdocstrings - Middleware Factory --------- Co-authored-by: Simon Thulbourn <[email protected]>
sinofseven · Feb 13, 2025 · d0f850b · d0f850b
1 parent 6bcea44
commit d0f850b
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
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 @@
		<!-- markdownlint-disable MD043 MD041 -->
		::: aws_lambda_powertools.middleware_factory