Some documentation work

Author: phschiele

docs/api_reference/dsp.problem.rst

@@ -2,9 +2,17 @@ Problem
 ====================
 
 SaddlePointProblem
-----
+------------------
 
 .. autoclass:: dsp.problem.SaddlePointProblem
-    :members: value, solve
+    :members: value, solve, status, is_dsp
+    :undoc-members:
+    :show-inheritance:
+
+MinimizeMaximize
+------------------
+
+.. autoclass:: dsp.problem.MinimizeMaximize
+    :members: value, is_dsp
     :undoc-members:
     :show-inheritance:

docs/api_reference/dsp.rst

@@ -6,3 +6,5 @@ Here goes the DSP API Documentation
    :maxdepth: 1
 
    Problems <dsp.problem>
+   Saddle Atoms <dsp.saddle_atoms>
+   Saddle Extremum <dsp.saddle_extremum>

docs/api_reference/dsp.saddle_atoms.rst

@@ -0,0 +1,23 @@
+Saddle Atoms
+====================
+
+SaddleAtom
+------------------
+
+.. autoclass:: dsp.saddle_atoms.SaddleAtom
+    :members: convex_variables, concave_variables, is_dsp
+    :undoc-members:
+    :show-inheritance:
+
+
+saddle_inner
+------------------
+
+.. autoclass:: dsp.saddle_atoms.saddle_inner
+
+inner
+------------------
+
+.. autoclass:: dsp.saddle_atoms.inner
+
+

docs/api_reference/dsp.saddle_extremum.rst

@@ -0,0 +1,11 @@
+Saddle Extremum functions
+=========================
+
+SaddleExtremum
+------------------
+
+.. autoclass:: dsp.saddle_extremum.SaddleExtremum
+    :members: convex_variables, concave_variables, is_dsp
+    :undoc-members:
+    :show-inheritance:
+

docs/index.rst

@@ -3,20 +3,23 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to DSP
+Disciplined Saddle Programming
 ===============================
 
-.. toctree::
-   :hidden:
-
-   API Documentation <api_reference/dsp>
+.. meta::
+   :description: A CVXPY extension for saddle problems
+   :keywords: convex optimization, python, cvxpy, saddle programming, saddle-point, modeling-language
 
+Disciplined Saddle Programming (DSP) is a CVXPY extension for saddle problems.
+DSP allows solving convex-concave saddle point problems, and more generally convex optimization problems we refer to
+as saddle problems, which include the partial supremum or infimum of convex-concave saddle functions. Saddle functions
+are functions that are (jointly) convex in a subset of their arguments, and (jointly) concave in the remaining
+arguments. A detailed description of the underlying method is given in our `accompanying paper <https://arxiv.org/abs/2301.13427>`_.
 
+This page contains the API documentation for DSP. We limit the public API to the functions and classes listed contained
+in this reference. The remainder of the code is considered private and may change without notice.
 
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. toctree::
+   :hidden:
 
+   API Documentation <api_reference/dsp>