scikit-learn-contrib · bellet · Jul 3, 2019 · May 22, 2019 · May 22, 2019 · Jun 11, 2019
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@ htmlcov/
 .cache/
 .pytest_cache/
 doc/auto_examples/*
+doc/generated/*
diff --git a/doc/_templates/class.rst b/doc/_templates/class.rst
@@ -0,0 +1,16 @@
+:mod:`{{module}}`.{{objname}}
+{{ underline }}==============
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :special-members: __init__
+
+.. include:: {{module}}.{{objname}}.examples
+
+.. raw:: html
+
+    <div style='clear:both'></div>
diff --git a/doc/conf.py b/doc/conf.py
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 import sys
+import os
 
 extensions = [
     'sphinx.ext.autodoc',
@@ -28,7 +29,6 @@
 exclude_patterns = ['_build']
 pygments_style = 'sphinx'
 todo_include_todos = True
-numpydoc_show_class_members = False
 
 # Options for HTML output
 html_theme = 'sphinx_rtd_theme'
@@ -50,3 +50,16 @@
     'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
     'scikit-learn': ('https://scikit-learn.org/stable/', None)
 }
+
+
+# sphinx-gallery configuration
+sphinx_gallery_conf = {
+    # to generate mini-galleries at the end of each docstring in the API
+    # section: (see https://sphinx-gallery.github.io/configuration.html
+    # #references-to-examples)
+    'doc_module': 'metric_learn',
+    'backreferences_dir': os.path.join('generated'),
+}
+
+# generate autosummary even if no references
+autosummary_generate = True
diff --git a/doc/index.rst b/doc/index.rst
@@ -25,7 +25,7 @@ Documentation outline
 .. toctree::
    :maxdepth: 2
 
-   Package Overview <metric_learn>
+   Package Contents <metric_learn>
 
 .. toctree::
    :maxdepth: 2

diff --git a/doc/metric_learn.base_metric.rst b/doc/metric_learn.base_metric.rst
diff --git a/doc/metric_learn.constraints.rst b/doc/metric_learn.constraints.rst
diff --git a/doc/metric_learn.covariance.rst b/doc/metric_learn.covariance.rst
diff --git a/doc/metric_learn.itml.rst b/doc/metric_learn.itml.rst
diff --git a/doc/metric_learn.lfda.rst b/doc/metric_learn.lfda.rst
diff --git a/doc/metric_learn.lmnn.rst b/doc/metric_learn.lmnn.rst
diff --git a/doc/metric_learn.lsml.rst b/doc/metric_learn.lsml.rst
diff --git a/doc/metric_learn.mlkr.rst b/doc/metric_learn.mlkr.rst
diff --git a/doc/metric_learn.mmc.rst b/doc/metric_learn.mmc.rst
diff --git a/doc/metric_learn.nca.rst b/doc/metric_learn.nca.rst
diff --git a/doc/metric_learn.rca.rst b/doc/metric_learn.rca.rst