Fix docs

Author: LeanderCS

docs/source/conf.py

@@ -12,10 +12,25 @@
     "sphinx.ext.napoleon",
 ]
 
+autodoc_default_options = {
+    "show-inheritance": True,
+}
+
 autodoc_member_order = "bysource"
 autodoc_typehints = "description"
 autoclass_content = "both"
 
+autodoc_type_aliases = {
+    "EstimatorPubLike": "EstimatorPubLike",
+    "SamplerPubLike": "SamplerPubLike",
+}
+
+autosummary_generate = True
+autosummary_generate_overwrite = False
+
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+
 sys.path.insert(0, os.path.abspath("../.."))
 
 templates_path = []

flask_inputfilter/_input_filter.pyx

@@ -436,8 +436,9 @@ cdef class InputFilter:
         given dictionary of data to the instance for further processing. It
         updates the internal state using the provided data.
 
-        Parameters:
-            data (dict[str, Any]): A dictionary containing the unfiltered
+        **Parameters**:
+        
+            - data (dict[str, Any]): A dictionary containing the unfiltered
                 data to be associated with the instance.
         """
         self.data = data

flask_inputfilter/conditions/custom_condition.py

@@ -13,8 +13,8 @@ class CustomCondition(BaseCondition):
     **Parameters:**
 
     - **condition** (*Callable[[dict[str, Any]], bool]*): A function that
-        takes the input data and returns a boolean indicating whether the
-        condition is met.
+      takes the input data and returns a boolean indicating whether the
+      condition is met.
 
     **Expected Behavior:**
 

flask_inputfilter/conditions/required_if_condition.py

@@ -13,9 +13,9 @@ class RequiredIfCondition(BaseCondition):
 
     - **condition_field** (*str*): The field whose value is checked.
     - **value** (*Optional[Union[Any, list[Any]]]*): The value(s) that
-        trigger the requirement.
+      trigger the requirement.
     - **required_field** (*str*): The field that becomes required if the
-        condition is met.
+      condition is met.
 
     **Expected Behavior:**
 

flask_inputfilter/filters/array_element_filter.py

@@ -12,7 +12,7 @@ class ArrayElementFilter(BaseFilter):
     **Parameters:**
 
     - **element_filter** (*BaseFilter* | *list[BaseFilter]*): A filter or a
-        list of filters to apply to each element in the array.
+      list of filters to apply to each element in the array.
 
     **Expected Behavior:**
 

flask_inputfilter/filters/array_explode_filter.py

@@ -12,7 +12,7 @@ class ArrayExplodeFilter(BaseFilter):
     **Parameters:**
 
     - **delimiter** (*str*, default: ``","``): The delimiter used to split
-        the string.
+      the string.
 
     **Expected Behavior:**
 

flask_inputfilter/filters/base_64_image_downscale_filter.py

@@ -17,14 +17,14 @@ class Base64ImageDownscaleFilter(BaseFilter):
     **Parameters:**
 
     - **size** (*Optional[int]*, default: ``1024 * 1024``): A rough pixel
-        count used to compute default dimensions.
+      count used to compute default dimensions.
     - **width** (*Optional[int]*, default: ``size**0.5``): The target width.
-        If not provided, it is calculated as ``sqrt(size)``.
+      If not provided, it is calculated as ``sqrt(size)``.
     - **height** (*Optional[int]*, default: ``size**0.5``): The target height.
-        If not provided, it is calculated as ``sqrt(size)``.
+      If not provided, it is calculated as ``sqrt(size)``.
     - **proportionally** (*bool*, default: ``True``): Determines if the image
-        should be scaled proportionally. If ``False``, the image is
-        forcefully resized to the specified width and height.
+      should be scaled proportionally. If ``False``, the image is
+      forcefully resized to the specified width and height.
 
     **Expected Behavior:**
 

flask_inputfilter/filters/base_64_image_resize_filter.py

@@ -18,13 +18,13 @@ class Base64ImageResizeFilter(BaseFilter):
     **Parameters:**
 
     - **max_size** (*int*, default: ``4 * 1024 * 1024``): The maximum
-        allowed file size in bytes.
+      allowed file size in bytes.
     - **format** (*ImageFormatEnum*, default: ``ImageFormatEnum.JPEG``):
-        The output image format.
+      The output image format.
     - **preserve_icc_profile** (*bool*, default: ``False``): If set to
-        ``True``, the ICC profile is preserved.
+      ``True``, the ICC profile is preserved.
     - **preserve_metadata** (*bool*, default: ``False``): If set to ``True``,
-        image metadata is preserved.
+      image metadata is preserved.
 
     **Expected Behavior:**
 

flask_inputfilter/filters/blacklist_filter.py

@@ -12,12 +12,12 @@ class BlacklistFilter(BaseFilter):
     **Parameters:**
 
     - **blacklist** (*list[str]*): A list of substrings (for strings) or keys
-        (for dictionaries) that should be removed.
+      (for dictionaries) that should be removed.
 
     **Expected Behavior:**
 
     - For strings: Removes any occurrence of blacklisted items and trims
-        whitespace.
+      whitespace.
     - For lists: Filters out items present in the blacklist.
     - For dictionaries: Removes key-value pairs where the key is blacklisted.
 

flask_inputfilter/filters/to_dataclass_filter.py

@@ -12,7 +12,7 @@ class ToDataclassFilter(BaseFilter):
     **Parameters:**
 
     - **dataclass_type** (*Type[dict]*): The target dataclass type
-        that the dictionary should be converted into.
+      that the dictionary should be converted into.
 
     **Expected Behavior:**