docs(api): migrating the AppConfig utility to mkdocstrings (#6008)

Mkdocstrings - AppConfig module

Author: leandrodamascena

aws_lambda_powertools/utilities/feature_flags/appconfig.py

@@ -1,3 +1,7 @@
+"""Advanced feature flags utility
+!!! abstract "Usage Documentation"
+    [`Feature Flags`](../../utilities/feature_flags.md)
+"""
 from __future__ import annotations
 
 import logging

aws_lambda_powertools/utilities/feature_flags/base.py

@@ -28,7 +28,8 @@ def get_configuration(self) -> dict[str, Any]:
         dict[str, Any]
             parsed JSON dictionary
 
-            **Example**
+        Example
+        -------
 
         ```python
         {

aws_lambda_powertools/utilities/feature_flags/comparators.py

@@ -56,6 +56,8 @@ def compare_time_range(context_value: Any, condition_value: dict) -> bool:
     end_time = current_time.replace(hour=int(end_hour), minute=int(end_min))
 
     if int(end_hour) < int(start_hour):
+        # In normal circumstances, we need to assert **both** conditions
+        """
         # When the end hour is smaller than start hour, it means we are crossing a day's boundary.
         # In this case we need to assert that current_time is **either** on one side or the other side of the boundary
         #
@@ -69,10 +71,9 @@ def compare_time_range(context_value: Any, condition_value: dict) -> bool:
         #                                             │ │                                        │
         #    └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─  │ └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─
         #                                               │
-
+        """
         return (start_time <= current_time) or (current_time <= end_time)
     else:
-        # In normal circumstances, we need to assert **both** conditions
         return start_time <= current_time <= end_time
 
 

aws_lambda_powertools/utilities/feature_flags/feature_flags.py

@@ -179,7 +179,8 @@ def get_configuration(self) -> dict:
         dict[str, dict]
             parsed JSON dictionary
 
-            **Example**
+        Example
+        -------
 
         ```python
         {
@@ -251,7 +252,7 @@ def evaluate(self, *, name: str, context: dict[str, Any] | None = None, default:
             Can be boolean or any JSON values for non-boolean features.
 
 
-        Examples
+        Example
         --------
 
         ```python
@@ -343,7 +344,8 @@ def get_enabled_features(self, *, context: dict[str, Any] | None = None) -> list
         list[str]
             list of all feature names that either matches context or have True as default
 
-            **Example**
+        Example
+        -------
 
         ```python
         ["premium_features", "my_feature_two", "always_true_feature"]
@@ -400,8 +402,8 @@ def validation_exception_handler(self, exc_class: Exception | list[Exception]):
         exc_class : Exception | list[Exception]
             One or more exceptions to catch
 
-        Examples
-        --------
+        Example
+        -------
 
         ```python
         feature_flags = FeatureFlags(store=app_config)

docs/api_doc/feature_flags/appconfig.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.feature_flags.appconfig

docs/api_doc/feature_flags/base.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.feature_flags.base

docs/api_doc/feature_flags/comparators.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.feature_flags.comparators

docs/api_doc/feature_flags/exceptions.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.feature_flags.exceptions

docs/api_doc/feature_flags/feature_flags.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.feature_flags.feature_flags

docs/api_doc/feature_flags/schema.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.feature_flags.schema

mkdocs.yml

@@ -63,6 +63,13 @@ nav:
           #     - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
           #     - Customer to advocate: contributing/tracks/customer_advocate.md
   - API Documentation:
+      - Feature Flags: 
+          - AppConfig: api_doc/feature_flags/appconfig.md
+          - Base: api_doc/feature_flags/base.md
+          - Comparators: api_doc/feature_flags/comparators.md
+          - Exceptions: api_doc/feature_flags/exceptions.md
+          - Feature flags: api_doc/feature_flags/feature_flags.md
+          - Schema: api_doc/feature_flags/schema.md
       - Idempotency: 
           - Base: api_doc/idempotency/base.md
           - Config: api_doc/idempotency/config.md