From 2841e8a657df0ff91790d24686a530248df79953 Mon Sep 17 00:00:00 2001 From: Leandro Damascena Date: Mon, 3 Feb 2025 22:31:28 +0000 Subject: [PATCH] Mkdocstrings - Tracer --- aws_lambda_powertools/tracing/base.py | 5 +++++ docs/api_doc/tracer/base.md | 2 ++ docs/api_doc/tracer/tracing.md | 2 ++ mkdocs.yml | 3 +++ 4 files changed, 12 insertions(+) create mode 100644 docs/api_doc/tracer/base.md create mode 100644 docs/api_doc/tracer/tracing.md diff --git a/aws_lambda_powertools/tracing/base.py b/aws_lambda_powertools/tracing/base.py index 74b146ad6e8..bcce4122f7d 100644 --- 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 new file mode 100644 index 00000000000..3973deb4c5d --- /dev/null +++ b/docs/api_doc/tracer/base.md @@ -0,0 +1,2 @@ + +::: aws_lambda_powertools.tracing.base diff --git a/docs/api_doc/tracer/tracing.md b/docs/api_doc/tracer/tracing.md new file mode 100644 index 00000000000..336f2e05cbc --- /dev/null +++ b/docs/api_doc/tracer/tracing.md @@ -0,0 +1,2 @@ + +::: aws_lambda_powertools.tracing.tracer diff --git a/mkdocs.yml b/mkdocs.yml index d9952b03ed0..194cbd1e9d1 100644 --- 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