docs(api): migrating the metrics utility to mkdocstrings

aws_lambda_powertools/metrics/base.py

@@ -1,3 +1,9 @@
+"""
+Metrics utility
+!!! abstract "Usage Documentation"
+    [`Metrics`](../../core/metrics.md)
+"""
+
 from __future__ import annotations
 
 import datetime

aws_lambda_powertools/metrics/provider/cloudwatch_emf/cloudwatch.py

@@ -330,7 +330,7 @@ def set_timestamp(self, timestamp: int | datetime.datetime):
         """
         Set the timestamp for the metric.
 
-        Parameters:
+        Parameters
         -----------
         timestamp: int | datetime.datetime
             The timestamp to create the metric.

docs/api_doc/metrics/base.md

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

docs/api_doc/metrics/exceptions.md

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

docs/api_doc/metrics/metrics.md

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

docs/api_doc/metrics/provider_datadog.md

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

docs/api_doc/metrics/provider_emf.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.metrics.provider.cloudwatch_emf.cloudwatch

mkdocs.yml

@@ -92,6 +92,12 @@ nav:
           - Formatter: api_doc/logger/formatter.md
           - Lambda Context: api_doc/logger/lambda_context.md
           - Logger: api_doc/logger/logger.md
+      - Metrics:
+          - Base: api_doc/metrics/base.md
+          - Exceptions: api_doc/metrics/exceptions.md
+          - Providers:
+            - EMF: api_doc/metrics/provider_emf.md
+            - DataDog: api_doc/metrics/provider_datadog.md
       - Middleware Factory: api_doc/middleware_factory.md
       - Parameters:
           - Base: api_doc/parameters/base.md