Skip to content

Commit

Permalink
docs(api): migrating the parser utility to mkdocstrings (#6004)
Browse files Browse the repository at this point in the history
* Mkdocstrings - Parser module

* Mkdocstrings - Parser module
  • Loading branch information
leandrodamascena authored Feb 3, 2025
1 parent cd8320d commit 5b9bdc7
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 0 deletions.
7 changes: 7 additions & 0 deletions aws_lambda_powertools/utilities/parser/parser.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
"""
The Parser utility simplifies data parsing and validation using Pydantic. It allows you to define data models
in pure Python classes, parse and validate incoming events, and extract only the data you need.
!!! abstract "Usage Documentation"
[`Parser`](../utilities/parser.md)
"""

from __future__ import annotations

import logging
Expand Down
2 changes: 2 additions & 0 deletions docs/api_doc/parser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!-- markdownlint-disable MD043 MD041 -->
::: aws_lambda_powertools.utilities.parser.parser
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ nav:
# - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
# - Customer to advocate: contributing/tracks/customer_advocate.md
- API Documentation:
- Parser: api_doc/parser.md
- Streaming: api_doc/streaming.md
- Typing: api_doc/typing.md
- Validation: api_doc/validation.md
Expand Down

0 comments on commit 5b9bdc7

Please sign in to comment.