docs(api): migrating the parameters utility to mkdocstrings (aws-powertools#6005)

leandrodamascena · sinofseven · commit d6eccc7735af · 2025-02-13T23:26:12.000+09:00
Mkdocstrings - Parameters  module
diff --git a/docs/api_doc/parameters/appconfig.md b/docs/api_doc/parameters/appconfig.md
@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.parameters.appconfig
diff --git a/docs/api_doc/parameters/base.md b/docs/api_doc/parameters/base.md
@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.parameters.base
diff --git a/docs/api_doc/parameters/dynamodb.md b/docs/api_doc/parameters/dynamodb.md
@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.parameters.dynamodb
diff --git a/docs/api_doc/parameters/secrets.md b/docs/api_doc/parameters/secrets.md
@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.parameters.secrets
diff --git a/docs/api_doc/parameters/ssm.md b/docs/api_doc/parameters/ssm.md
@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.parameters.ssm
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -63,6 +63,12 @@ nav:
           #     - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
           #     - Customer to advocate: contributing/tracks/customer_advocate.md
   - API Documentation:
+      - Parameters:
+          - Base: api_doc/parameters/base.md
+          - AppConfig: api_doc/parameters/appconfig.md
+          - DynamoDB: api_doc/parameters/dynamodb.md
+          - SSM: api_doc/parameters/ssm.md
+          - Secrets: api_doc/parameters/secrets.md
       - Parser: api_doc/parser.md
       - Streaming: api_doc/streaming.md
       - Typing: api_doc/typing.md

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