[MRG] Export notebook to gallery (#180)

wdevazelhes · bellet · commit fbd92ff91004 · 2019-06-05T11:44:24.000+02:00
* Export notebook to gallery * Fix the figure number in order to get the image printed in the logo of the example * wip replace dataset by faces * Finalize notebook * change dataset for make_classification * Add comments on the properties of the algorithms * Address #180 (review) * Address #180 (review) * a few updates and minor corrections
diff --git a/doc/introduction.rst b/doc/introduction.rst
@@ -1,3 +1,5 @@
+.. _intro_metric_learning:
+
 ========================
 What is Metric Learning?
 ========================
@@ -77,6 +79,8 @@ necessarily the identity of indiscernibles.
   parameterizations are equivalent. In practice, an algorithm may thus solve
   the metric learning problem with respect to either :math:`M` or :math:`L`.
 
+.. _use_cases:
+
 Use-cases
 =========
 
diff --git a/doc/metric_learn.constraints.rst b/doc/metric_learn.constraints.rst
@@ -0,0 +1,7 @@
+metric_learn.constraints module
+===============================
+
+.. automodule:: metric_learn.constraints
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/metric_learn.rst b/doc/metric_learn.rst
@@ -6,6 +6,7 @@ Module Contents
 
 .. toctree::
 
+   metric_learn.constraints
    metric_learn.base_metric
    metric_learn.itml
    metric_learn.lfda
diff --git a/doc/weakly_supervised.rst b/doc/weakly_supervised.rst
@@ -118,6 +118,7 @@ through the argument `preprocessor`.
    paths in the filesystem, name of records in a database etc...) See section
    :ref:`preprocessor_section` for more details on how to use the preprocessor.
 
+.. _sklearn_compat_ws:
 
 Scikit-learn compatibility
 ==========================
diff --git a/examples/metric_plotting.ipynb b/examples/metric_plotting.ipynb
diff --git a/examples/plot_metric_learning_examples.py b/examples/plot_metric_learning_examples.py
