Merge pull request #77 from mrava87/main

Reorganized api index

Author: mrava87

docs/source/api/index.rst

@@ -17,21 +17,22 @@ Orthogonal projections
 .. autosummary::
    :toctree: generated/
 
+    AffineSetProj
     BoxProj
+    EuclideanBallProj
     HyperPlaneBoxProj
-    SimplexProj
+    IntersectionProj
     L0BallProj
     L1BallProj
-    EuclideanBallProj
     NuclearBallProj
-    IntersectionProj
-    AffineSetProj
+    SimplexProj
 
 Proximal operators
 ------------------
 
 Templates
-~~~~~~~~~
+^^^^^^^^^
+
 .. currentmodule:: pyproximal
 
 .. autosummary::
@@ -46,43 +47,69 @@ Templates
 
     moreau
 
+.. currentmodule:: pyproximal
 
-Operators
-~~~~~~~~~
+Vector
+^^^^^^
 
-.. currentmodule:: pyproximal
+Convex
+~~~~~~
 
 .. autosummary::
    :toctree: generated/
 
-    Box
-    Simplex
-    Intersection
     AffineSet
-    Quadratic
+    Box
     Euclidean
     EuclideanBall
+    Huber
+    Intersection
     L0Ball
     L1
     L1Ball
     L2
     L2Convolve
     L21
     L21_plus_L1
-    Nonlinear
-    Huber
-    Nuclear
-    NuclearBall
     Orthogonal
-    VStack
-    SCAD
-    Log
+    Quadratic
+    Simplex
+
+
+Non-Convex
+~~~~~~~~~~
+
+.. autosummary::
+   :toctree: generated/
+
     ETP
     Geman
+    Log
     QuadraticEnvelopeCard
+    SCAD
+
+
+Matrix-only
+^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: generated/
+
+    Nuclear
+    NuclearBall
     SingularValuePenalty
 
 
+Other
+^^^^^
+
+.. autosummary::
+   :toctree: generated/
+
+    Nonlinear
+    VStack
+
+
 Other operators
 ---------------
 
@@ -99,55 +126,55 @@ Solvers
 -------
 
 Primal
-~~~~~~
+^^^^^^
 
 .. currentmodule:: pyproximal.optimization.primal
 
 .. autosummary::
    :toctree: generated/
 
-    ProximalPoint
-    ProximalGradient
     AcceleratedProximalGradient
     ADMM
     LinearizedADMM
+    ProximalGradient
+    ProximalPoint
     TwIST
 
-.. currentmodule:: pyproximal.optimization.sr3
+.. currentmodule:: pyproximal.optimization.palm
 
 .. autosummary::
    :toctree: generated/
 
-    SR3
+    PALM
 
-.. currentmodule:: pyproximal.optimization.palm
+.. currentmodule:: pyproximal.optimization.pnp
 
 .. autosummary::
    :toctree: generated/
 
-    PALM
+    PlugAndPlay
 
-.. currentmodule:: pyproximal.optimization.pnp
+.. currentmodule:: pyproximal.optimization.sr3
 
 .. autosummary::
    :toctree: generated/
 
-    PlugAndPlay
+    SR3
 
 
 Primal-dual
-~~~~~~~~~~~
+^^^^^^^^^^^
 
 .. currentmodule:: pyproximal.optimization.primaldual
 
 .. autosummary::
    :toctree: generated/
 
-    PrimalDual
     AdaptivePrimalDual
+    PrimalDual
 
 Other
-~~~~~
+^^^^^
 
 .. currentmodule:: pyproximal.optimization.bregman