docs(api): add parametrization api documentation

matosys · matosys · commit 3cef53bd1763 · 2024-11-14T15:34:16.000+04:00
diff --git a/doc/source/api/decorator.rst b/doc/source/api/decorator.rst
@@ -32,3 +32,13 @@ Decorator `@balder.insert_into_tree(..)`
 ========================================
 
 .. autofunction:: balder.insert_into_tree
+
+Decorator `@balder.parametrize(..)`
+===================================
+
+.. autofunction:: balder.parametrize
+
+Decorator `@balder.parametrize_by_feature(..)`
+==============================================
+
+.. autofunction:: balder.parametrize_by_feature
diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst
@@ -16,3 +16,4 @@ Here you can find the full API documentation of the Balder Framework.
     scenarios.rst
     setups.rst
     controllers.rst
+    parametrization.rst
diff --git a/doc/source/api/parametrization.rst b/doc/source/api/parametrization.rst
@@ -0,0 +1,28 @@
+Parametrization API
+*******************
+
+Providing arguments for dynamic parametrization
+===============================================
+
+The following objects help to provide parameters inside the dynamic parametrization decorator
+:meth:`balder.parametrize_by_feature`.
+
+The ``Value`` object
+--------------------
+
+.. autoclass:: balder.parametrization.Value
+    :members:
+
+
+The ``Parameter`` object
+------------------------
+
+.. autoclass:: balder.parametrization.Parameter
+    :members:
+
+
+The ``FeatureAccessSelector`` object
+------------------------------------
+
+.. autoclass:: balder.parametrization.FeatureAccessSelector
+    :members:
