docs: use autosummary to split documentation pages

Author: tswast

bigframes/ml/base.py

@@ -15,10 +15,12 @@
 """
 Wraps primitives for machine learning with BQML
 
-This library is an evolving attempt to
-- implement BigQuery DataFrames API for BQML
-- follow as close as possible the API design of SKLearn
+This library is an evolving attempt to:
+
+* implement BigQuery DataFrames API for BQML
+* follow as close as possible the API design of SKLearn
     https://arxiv.org/pdf/1309.0238.pdf
+
 """
 
 import abc
@@ -46,12 +48,16 @@ class BaseEstimator(bigframes_vendored.sklearn.base.BaseEstimator, abc.ABC):
     assumed to be the list of hyperparameters.
 
     All descendents of this class should implement:
+
+    .. code-block:: python
+
         def __init__(self, hyperparameter_1=default_1, hyperparameter_2=default_2, hyperparameter3, ...):
             '''Set hyperparameters'''
             self.hyperparameter_1 = hyperparameter_1
             self.hyperparameter_2 = hyperparameter_2
             self.hyperparameter3 = hyperparameter3
             ...
+
     Note: the object variable names must be exactly the same with parameter names. In order to utilize __repr__.
 
     fit(X, y) method is optional.

bigframes/pandas/__init__.py

@@ -306,11 +306,22 @@ def clean_up_by_session_id(
 
 # pandas dtype attributes
 NA = pandas.NA
+"""Alias for :class:`pandas.NA`."""
+
 BooleanDtype = pandas.BooleanDtype
+"""Alias for :class:`pandas.BooleanDtype`."""
+
 Float64Dtype = pandas.Float64Dtype
+"""Alias for :class:`pandas.Float64Dtype`."""
+
 Int64Dtype = pandas.Int64Dtype
+"""Alias for :class:`pandas.Int64Dtype`."""
+
 StringDtype = pandas.StringDtype
+"""Alias for :class:`pandas.StringDtype`."""
+
 ArrowDtype = pandas.ArrowDtype
+"""Alias for :class:`pandas.ArrowDtype`."""
 
 # Class aliases
 # TODO(swast): Make these real classes so we can refer to these in type

docs/_templates/autosummary/class.rst

@@ -0,0 +1 @@
+../../../third_party/bigframes_vendored/pandas/doc/_templates/autosummary/class.rst

docs/reference/.gitignore

@@ -0,0 +1 @@
+api/*