Skip to content

Commit 6a3327f

Browse files
leandrodamascenasinofseven
authored andcommitted
docs(api): migrating the tracer utility to mkdocstrings (aws-powertools#6017)
Mkdocstrings - Tracer
1 parent 8967681 commit 6a3327f

File tree

4 files changed

+12
-0
lines changed

4 files changed

+12
-0
lines changed

aws_lambda_powertools/tracing/base.py

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
"""
2+
Tracing utility
3+
!!! abstract "Usage Documentation"
4+
[`Tracer`](../../core/tracer.md)
5+
"""
16
from __future__ import annotations
27

38
import abc

docs/api_doc/tracer/base.md

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

docs/api_doc/tracer/tracing.md

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

mkdocs.yml

+3
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,9 @@ nav:
9494
- Secrets: api_doc/parameters/secrets.md
9595
- Parser: api_doc/parser.md
9696
- Streaming: api_doc/streaming.md
97+
- Tracer:
98+
- Base: api_doc/tracer/base.md
99+
- Tracing: api_doc/tracer/tracing.md
97100
- Typing: api_doc/typing.md
98101
- Validation: api_doc/validation.md
99102

0 commit comments

Comments
 (0)