docs(api): migrating the tracer utility to mkdocstrings (#6017)

leandrodamascena · web-flow · commit a0159ac22e3e · 2025-02-04T08:51:49.000Z
Mkdocstrings - Tracer
diff --git a/aws_lambda_powertools/tracing/base.py b/aws_lambda_powertools/tracing/base.py
@@ -1,3 +1,8 @@
+"""
+Tracing utility
+!!! abstract "Usage Documentation"
+    [`Tracer`](../../core/tracer.md)
+"""
 from __future__ import annotations
 
 import abc
diff --git a/docs/api_doc/tracer/base.md b/docs/api_doc/tracer/base.md
@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.tracing.base
diff --git a/docs/api_doc/tracer/tracing.md b/docs/api_doc/tracer/tracing.md
@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.tracing.tracer
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -94,6 +94,9 @@ nav:
           - Secrets: api_doc/parameters/secrets.md
       - Parser: api_doc/parser.md
       - Streaming: api_doc/streaming.md
+      - Tracer:
+          - Base: api_doc/tracer/base.md
+          - Tracing: api_doc/tracer/tracing.md
       - Typing: api_doc/typing.md
       - Validation: api_doc/validation.md
 

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