From 80c1a07deac5f0dad3e795e6f618a4c16af1d698 Mon Sep 17 00:00:00 2001 From: Leandro Damascena Date: Tue, 4 Feb 2025 09:31:49 +0000 Subject: [PATCH 1/2] Mkdocstrings - Middleware Factory --- aws_lambda_powertools/middleware_factory/__init__.py | 5 ++++- docs/api_doc/middleware_factory.md | 2 ++ mkdocs.yml | 1 + 3 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 docs/api_doc/middleware_factory.md diff --git a/aws_lambda_powertools/middleware_factory/__init__.py b/aws_lambda_powertools/middleware_factory/__init__.py index cdeb1e6262e..aefd6c0b577 100644 --- 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 middlewares +!!! 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 new file mode 100644 index 00000000000..8d5f5221c11 --- /dev/null +++ b/docs/api_doc/middleware_factory.md @@ -0,0 +1,2 @@ + +::: aws_lambda_powertools.middleware_factory diff --git a/mkdocs.yml b/mkdocs.yml index 194cbd1e9d1..ac00c887248 100644 --- 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 From c1f11780720341ff41b3b6adfcf83dd87b44d7fb Mon Sep 17 00:00:00 2001 From: Leandro Damascena Date: Tue, 4 Feb 2025 10:07:12 +0000 Subject: [PATCH 2/2] Mkdocstrings - Middleware Factory --- aws_lambda_powertools/middleware_factory/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aws_lambda_powertools/middleware_factory/__init__.py b/aws_lambda_powertools/middleware_factory/__init__.py index aefd6c0b577..ebdb338cc15 100644 --- a/aws_lambda_powertools/middleware_factory/__init__.py +++ b/aws_lambda_powertools/middleware_factory/__init__.py @@ -1,4 +1,4 @@ -"""Utilities to enhance middlewares +"""Utilities to enhance middleware !!! abstract "Usage Documentation" [`Middleware Factory`](../utilities/middleware_factory.md) """