docs: add streaming html docs (#884)

* docs: add streaming html docs

* add beta icon

* add beta icon in toc.yml

Author: GarrettWu

bigframes/session/__init__.py

@@ -760,7 +760,9 @@ def read_gbq_table_streaming(
     ) -> streaming_dataframe.StreamingDataFrame:
         """Turn a BigQuery table into a StreamingDataFrame.
 
-        Note: The bigframes.streaming module is a preview feature, and subject to change.
+        .. note::
+
+            The bigframes.streaming module is a preview feature, and subject to change.
 
         **Examples:**
 

bigframes/streaming/dataframe.py

@@ -191,7 +191,16 @@ def to_pubsub(
 
 @log_adapter.class_logger
 class StreamingDataFrame(StreamingBase):
-    __doc__ = _curate_df_doc(dataframe.DataFrame.__doc__)
+    __doc__ = (
+        _curate_df_doc(dataframe.DataFrame.__doc__)
+        + """
+    .. note::
+
+        The bigframes.streaming module is a preview feature, and subject to change.
+
+    Currently only supports basic projection, filtering and preview operations.
+    """
+    )
 
     # Private constructor
     _create_key = object()

docs/reference/bigframes.streaming/dataframe.rst

@@ -0,0 +1,6 @@
+bigframes.streaming.dataframe
+=============================
+
+.. autoclass:: bigframes.streaming.dataframe.StreamingDataFrame
+    :members:
+    :inherited-members:

docs/reference/bigframes.streaming/index.rst

@@ -0,0 +1,13 @@
+
+============================
+BigQuery DataFrame Streaming
+============================
+
+.. automodule:: bigframes.streaming
+    :members:
+    :undoc-members:
+
+.. toctree::
+    :maxdepth: 2
+
+    dataframe

docs/reference/index.rst

@@ -11,3 +11,4 @@ packages.
     bigframes.pandas/index
     bigframes.ml/index
     bigframes.bigquery/index
+    bigframes.streaming/index

docs/templates/toc.yml

@@ -203,4 +203,11 @@
     - name: BigQuery built-in functions
       uid: bigframes.bigquery
     name: bigframes.bigquery
+  - items:
+    - name: Overview
+      uid: bigframes.streaming
+    - name: StreamingDataFrame
+      uid: bigframes.streaming.dataframe.StreamingDataFrame
+    name: bigframes.streaming
+    status: beta
   name: BigQuery DataFrames