DOC fix docs built for QuadraticGroup and WeightedGroupL2 (#31)

Author: Badr-MOUFAD

doc/api.rst

@@ -51,9 +51,9 @@ Datafits
 .. autosummary::
    :toctree: generated/
 
-   GroupQuadratic
    Logistic
    Quadratic
+   QuadraticGroup
    QuadraticSVC
 
 

skglm/datafits/__init__.py

@@ -5,3 +5,5 @@
 )
 
 from .multi_task import QuadraticMultiTask  # noqa F401
+
+from .group import QuadraticGroup  # noqa F401

skglm/datafits/group.py

@@ -15,7 +15,7 @@
 
 @jitclass(spec_QuadraticGroup)
 class QuadraticGroup(BaseDatafit):
-    """Quadratic datafit used with group penalties.
+    r"""Quadratic datafit used with group penalties.
 
     The datafit reads::
 
@@ -25,7 +25,7 @@ class QuadraticGroup(BaseDatafit):
     ----------
     grp_indices : array, shape (n_features,)
         The group indices stacked contiguously
-        (e.g. [grp1_indices, grp2_indices, ...]).
+        ([grp1_indices, grp2_indices, ...]).
 
     grp_ptr : array, shape (n_groups + 1,)
         The group pointers such that two consecutive elements delimit

skglm/penalties/__init__.py

@@ -4,4 +4,4 @@
     L1_plus_L2, L0_5, L1, L2_3, MCPenalty, WeightedL1, IndicatorBox, BasePenalty
 )
 
-from .block_separable import L2_05, L2_1, BlockMCPenalty  # noqa F401
+from .block_separable import L2_05, L2_1, BlockMCPenalty, WeightedGroupL2  # noqa F401

skglm/penalties/block_separable.py

@@ -182,7 +182,7 @@ class WeightedGroupL2(BasePenalty):
 
     grp_indices : array, shape (n_features,)
         The group indices stacked contiguously
-        (e.g. [grp1_indices, grp2_indices, ...]).
+        ([grp1_indices, grp2_indices, ...]).
 
     grp_ptr : array, shape (n_groups + 1,)
         The group pointers such that two consecutive elements delimit