Use autodoc better to generate dataframe and groupby docs

Author: rgommers

spec/API_specification/dataframe_api/dataframe_object.py

@@ -11,6 +11,16 @@
 
 
 class DataFrame:
+    """
+    A DataFrame.
+
+    Notes
+    -----
+    Note that this DataFrame class is not meant to be instantiated directly by
+    users of the library implementing the dataframe API standard. Rather, use
+    constructor functions or an already-created dataframe object retrieved via
+    
+    """
     @property
     def dataframe(self) -> object:
         """

spec/API_specification/dataframe_api/groupby_object.py

@@ -4,7 +4,19 @@
     from .dataframe_object import DataFrame
 
 
+__all__ = ['GroupBy']
+
+
 class GroupBy:
+    """
+    GroupBy class.
+
+    Note that this class is not meant to be constructed by users.
+    It is returned from `DataFrame.groupby`.
+
+    **Methods**
+
+    """
     def any(self, skip_nulls: bool = True) -> "DataFrame":
         ...
 

spec/API_specification/dataframe_object.rst

@@ -149,24 +149,5 @@ TODO
 
 Methods
 -------
-..
-  NOTE: please keep the methods in alphabetical order
-
-
-.. autosummary::
-   :toctree: generated
-   :template: property.rst
 
-   DataFrame.__add__
-   DataFrame.__eq__
-   DataFrame.__floordiv__
-   DataFrame.__ge__
-   DataFrame.__gt__
-   DataFrame.__le__
-   DataFrame.__lt__
-   DataFrame.__ne__
-   DataFrame.__mod__
-   DataFrame.__mul__
-   DataFrame.__pow__
-   DataFrame.__sub__
-   DataFrame.__truediv__
+.. autoclass:: DataFrame

spec/API_specification/groupby_object.rst

@@ -6,26 +6,11 @@ Groupby object
 A conforming implementation of the dataframe API standard must provide and
 support a groupby object having the following attributes and methods.
 
--------------------------------------------------
-
-Methods
--------
-..
-  NOTE: please keep the methods in alphabetical order
-
 .. currentmodule:: dataframe_api
 
 .. autosummary::
    :toctree: generated
-   :template: property.rst
+   :template: class.rst
+
+   GroupBy
 
-   GroupBy.all
-   GroupBy.any
-   GroupBy.max
-   GroupBy.min
-   GroupBy.mean
-   GroupBy.median
-   GroupBy.prod
-   GroupBy.std
-   GroupBy.sum
-   GroupBy.var

spec/conf.py

@@ -46,7 +46,15 @@
 
 autosummary_generate = True
 autodoc_typehints = 'signature'
+autodoc_default_options = {
+#    'attributes':       True,
+    'members':          True,
+    'special-members':  True,
+    'undoc-members':    True,
+    'exclude-members': '__annotations__, __dict__',
+}
 add_module_names = False
+napoleon_numpy_docstring = True
 napoleon_custom_sections = [('Returns', 'params_style')]
 default_role = 'code'