Skip to content

Commit e93b244

Browse files
leandrodamascenasinofseven
authored andcommitted
docs(api): migrating the event source data classes utility to mkdocstrings (aws-powertools#6015)
Mkdocstrings - Data Classes module
1 parent 90302ef commit e93b244

File tree

5 files changed

+11
-0
lines changed

5 files changed

+11
-0
lines changed

aws_lambda_powertools/utilities/data_classes/common.py

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
"""
2+
Base class for Event Source Data Classes
3+
!!! abstract "Usage Documentation"
4+
[`Data classes`](../utilities/data_classes.md)
5+
"""
6+
17
from __future__ import annotations
28

39
import base64

aws_lambda_powertools/utilities/feature_flags/appconfig.py

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
!!! abstract "Usage Documentation"
33
[`Feature Flags`](../../utilities/feature_flags.md)
44
"""
5+
56
from __future__ import annotations
67

78
import logging

aws_lambda_powertools/utilities/jmespath_utils/__init__.py

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
!!! abstract "Usage Documentation"
44
[`JMESPath Functions`](../utilities/jmespath_functions.md)
55
"""
6+
67
from __future__ import annotations
78

89
import base64

docs/api_doc/data_classes.md

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

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ nav:
6363
# - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
6464
# - Customer to advocate: contributing/tracks/customer_advocate.md
6565
- API Documentation:
66+
- Event Source Data Classes: api_doc/data_classes.md
6667
- Data Masking:
6768
- Base: api_doc/data_masking/base.md
6869
- Exception: api_doc/data_masking/exceptions.md

0 commit comments

Comments
 (0)