MNT update the way the documentation is shown

Author: glemaitre

doc/_templates/class.rst

@@ -5,10 +5,6 @@
 
 .. autoclass:: {{ objname }}
 
-   {% block methods %}
-   .. automethod:: __init__
-   {% endblock %}
-
 .. include:: {{module}}.{{objname}}.examples
 
 .. raw:: html

doc/_templates/numpydoc_docstring.py renamed to doc/_templates/numpydoc_docstring.rst

@@ -13,4 +13,4 @@
 {{notes}}
 {{references}}
 {{examples}}
-{{methods}}
+{{methods}}

doc/api.rst

@@ -154,11 +154,11 @@ Prototype selection
 .. autosummary::
    :toctree: generated/
    :template: function.rst
-              
+
    tensorflow.balanced_batch_generator
 
 .. _misc_ref:
-   
+
 Miscellaneous
 =============
 

doc/conf.py

@@ -50,7 +50,10 @@
 extensions.append('sphinx.ext.imgmath')
 imgmath_image_format = 'svg'
 
-autodoc_default_flags = ['members', 'inherited-members']
+autodoc_default_options = {
+    "members": True,
+    "inherited-members": True,
+}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -309,6 +312,30 @@
 issues_github_path = 'scikit-learn-contrib/imbalanced-learn'
 issues_user_uri = 'https://github.com/{user}'
 
+# Hack to get kwargs to appear in docstring #18434
+# TODO: Remove when https://github.com/sphinx-doc/sphinx/pull/8234 gets
+# merged
+from sphinx.util import inspect  # noqa
+from sphinx.ext.autodoc import ClassDocumenter  # noqa
+
+
+class PatchedClassDocumenter(ClassDocumenter):
+    def _get_signature(self):
+        old_signature = inspect.signature
+
+        def patch_signature(subject, bound_method=False, follow_wrapped=True):
+            # changes the default of follow_wrapped to True
+            return old_signature(
+                subject,
+                bound_method=bound_method,
+                follow_wrapped=follow_wrapped,
+            )
+
+        inspect.signature = patch_signature
+        result = super()._get_signature()
+        inspect.signature = old_signature
+        return result
+
 
 # Temporary work-around for spacing problem between parameter and parameter
 # type in the doc, see https://github.com/numpy/numpydoc/issues/215. The bug
@@ -317,7 +344,8 @@
 # In an ideal world, this would get fixed in this PR:
 # https://github.com/readthedocs/sphinx_rtd_theme/pull/747/files
 def setup(app):
-    app.add_javascript('js/copybutton.js')
+    app.registry.documenters["class"] = PatchedClassDocumenter
+    app.add_javascript("js/copybutton.js")
     app.add_stylesheet("basic.css")
     # app.connect('autodoc-process-docstring', generate_example_rst)
 

imblearn/ensemble/_bagging.py

@@ -140,13 +140,17 @@ class BalancedBaggingClassifier(BaggingClassifier):
     ----------
     .. [1] L. Breiman, "Pasting small votes for classification in large
            databases and on-line", Machine Learning, 36(1), 85-103, 1999.
+
     .. [2] L. Breiman, "Bagging predictors", Machine Learning, 24(2), 123-140,
            1996.
+
     .. [3] T. Ho, "The random subspace method for constructing decision
            forests", Pattern Analysis and Machine Intelligence, 20(8), 832-844,
            1998.
+
     .. [4] G. Louppe and P. Geurts, "Ensembles on Random Patches", Machine
            Learning and Knowledge Discovery in Databases, 346-361, 2012.
+
     .. [5] Chen, Chao, Andy Liaw, and Leo Breiman. "Using random forest to
            learn imbalanced data." University of California, Berkeley 110,
            2004.

imblearn/over_sampling/_random_over_sampler.py

@@ -36,7 +36,7 @@ class RandomOverSampler(BaseOverSampler):
 
     Attributes
     ----------
-    sample_indices_ : ndarray of shape (n_new_samples)
+    sample_indices_ : ndarray of shape (n_new_samples,)
         Indices of the samples selected.
 
         .. versionadded:: 0.4

imblearn/under_sampling/_prototype_selection/_condensed_nearest_neighbour.py

@@ -52,7 +52,7 @@ class CondensedNearestNeighbour(BaseCleaningSampler):
 
     Attributes
     ----------
-    sample_indices_ : ndarray of shape (n_new_samples)
+    sample_indices_ : ndarray of shape (n_new_samples,)
         Indices of the samples selected.
 
         .. versionadded:: 0.4

imblearn/under_sampling/_prototype_selection/_edited_nearest_neighbours.py

@@ -56,7 +56,7 @@ class EditedNearestNeighbours(BaseCleaningSampler):
 
     Attributes
     ----------
-    sample_indices_ : ndarray of shape (n_new_samples)
+    sample_indices_ : ndarray of shape (n_new_samples,)
         Indices of the samples selected.
 
         .. versionadded:: 0.4
@@ -199,7 +199,7 @@ class RepeatedEditedNearestNeighbours(BaseCleaningSampler):
 
     Attributes
     ----------
-    sample_indices_ : ndarray of shape (n_new_samples)
+    sample_indices_ : ndarray of shape (n_new_samples,)
         Indices of the samples selected.
 
         .. versionadded:: 0.4
@@ -383,7 +383,7 @@ class without early stopping.
 
     Attributes
     ----------
-    sample_indices_ : ndarray of shape (n_new_samples)
+    sample_indices_ : ndarray of shape (n_new_samples,)
         Indices of the samples selected.
 
         .. versionadded:: 0.4

imblearn/under_sampling/_prototype_selection/_instance_hardness_threshold.py

@@ -57,7 +57,7 @@ class InstanceHardnessThreshold(BaseUnderSampler):
 
     Attributes
     ----------
-    sample_indices_ : ndarray of shape (n_new_samples)
+    sample_indices_ : ndarray of shape (n_new_samples,)
         Indices of the samples selected.
 
         .. versionadded:: 0.4

imblearn/under_sampling/_prototype_selection/_nearmiss.py

@@ -53,7 +53,7 @@ class NearMiss(BaseUnderSampler):
 
     Attributes
     ----------
-    sample_indices_ : ndarray of shape (n_new_samples)
+    sample_indices_ : ndarray of shape (n_new_samples,)
         Indices of the samples selected.
 
         .. versionadded:: 0.4