docs: add notebooks to user guide page (#2505)

Thank you for opening a Pull Request! Before submitting your PR, there
are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a
[bug/issue](https://github.com/googleapis/python-bigquery-dataframes/issues/new/choose)
before writing your code! That way we can discuss the change, evaluate
designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)

Fixes #<issue_number_goes_here> 🦕

Author: tswast

.github/workflows/docs.yml

@@ -36,6 +36,3 @@ jobs:
       run: |
         python -m pip install --upgrade setuptools pip wheel
         python -m pip install nox
-    - name: Run docfx
-      run: |
-        nox -s docfx

docs/conf.py

@@ -59,9 +59,12 @@
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx_sitemap",
-    "myst_parser",
+    "myst_nb",
 ]
 
+# myst-nb configuration
+nb_execution_mode = "off"
+
 # autodoc/autosummary flags
 autoclass_content = "both"
 autodoc_default_options = {"members": True}
@@ -269,12 +272,14 @@
 
 
 suppress_warnings = [
+    # Allow unknown mimetype so we can use widgets in tutorial notebooks.
+    "mystnb.unknown_mime_type",
     # Temporarily suppress this to avoid "more than one target found for
     # cross-reference" warning, which are intractable for us to avoid while in
     # a mono-repo.
     # See https://github.com/sphinx-doc/sphinx/blob
     # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843
-    "ref.python"
+    "ref.python",
 ]
 
 # -- Options for LaTeX output ---------------------------------------------

docs/notebooks

@@ -0,0 +1 @@
+../notebooks

docs/user_guide/index.rst

@@ -9,3 +9,116 @@ User Guide
 
    Getting Started <https://docs.cloud.google.com/bigquery/docs/dataframes-quickstart>
    Cloud Docs User Guides <https://docs.cloud.google.com/bigquery/docs/bigquery-dataframes-introduction>
+
+.. toctree::
+   :caption: Getting Started
+   :maxdepth: 1
+
+   Quickstart Template <../notebooks/getting_started/bq_dataframes_template.ipynb>
+   Getting Started <../notebooks/getting_started/getting_started_bq_dataframes.ipynb>
+   Magics <../notebooks/getting_started/magics.ipynb>
+   ML Fundamentals <../notebooks/getting_started/ml_fundamentals_bq_dataframes.ipynb>
+
+.. toctree::
+   :caption: DataFrames
+   :maxdepth: 1
+
+   Anywidget Mode <../notebooks/dataframes/anywidget_mode.ipynb>
+   Dataframe <../notebooks/dataframes/dataframe.ipynb>
+   Index Col Null <../notebooks/dataframes/index_col_null.ipynb>
+   Integrations <../notebooks/dataframes/integrations.ipynb>
+   Pypi <../notebooks/dataframes/pypi.ipynb>
+
+.. toctree::
+   :caption: Data Types
+   :maxdepth: 1
+
+   Array <../notebooks/data_types/array.ipynb>
+   Json <../notebooks/data_types/json.ipynb>
+   Struct <../notebooks/data_types/struct.ipynb>
+   Timedelta <../notebooks/data_types/timedelta.ipynb>
+
+.. toctree::
+   :caption: Generative AI
+   :maxdepth: 1
+
+   AI Functions <../notebooks/generative_ai/ai_functions.ipynb>
+   AI Forecast <../notebooks/generative_ai/bq_dataframes_ai_forecast.ipynb>
+   LLM Code Generation <../notebooks/generative_ai/bq_dataframes_llm_code_generation.ipynb>
+   LLM KMeans <../notebooks/generative_ai/bq_dataframes_llm_kmeans.ipynb>
+   LLM Output Schema <../notebooks/generative_ai/bq_dataframes_llm_output_schema.ipynb>
+   LLM Vector Search <../notebooks/generative_ai/bq_dataframes_llm_vector_search.ipynb>
+   Drug Name Generation <../notebooks/generative_ai/bq_dataframes_ml_drug_name_generation.ipynb>
+   Large Language Models <../notebooks/generative_ai/large_language_models.ipynb>
+
+.. toctree::
+   :caption: Machine Learning
+   :maxdepth: 1
+
+   ML Cross Validation <../notebooks/ml/bq_dataframes_ml_cross_validation.ipynb>
+   Linear Regression <../notebooks/ml/bq_dataframes_ml_linear_regression.ipynb>
+   Linear Regression BBQ <../notebooks/ml/bq_dataframes_ml_linear_regression_bbq.ipynb>
+   Linear Regression Big <../notebooks/ml/bq_dataframes_ml_linear_regression_big.ipynb>
+   Easy Linear Regression <../notebooks/ml/easy_linear_regression.ipynb>
+   Sklearn Linear Regression <../notebooks/ml/sklearn_linear_regression.ipynb>
+   Timeseries Analysis <../notebooks/ml/timeseries_analysis.ipynb>
+
+.. toctree::
+   :caption: Visualization
+   :maxdepth: 1
+
+   COVID Line Graphs <../notebooks/visualization/bq_dataframes_covid_line_graphs.ipynb>
+   Tutorial <../notebooks/visualization/tutorial.ipynb>
+
+.. toctree::
+   :caption: Geospatial Data
+   :maxdepth: 1
+
+   Geoseries <../notebooks/geo/geoseries.ipynb>
+
+.. toctree::
+   :caption: Regionalized BigQuery
+   :maxdepth: 1
+
+   Regionalized <../notebooks/location/regionalized.ipynb>
+
+.. toctree::
+   :caption: Multimodal
+   :maxdepth: 1
+
+   Multimodal Dataframe <../notebooks/multimodal/multimodal_dataframe.ipynb>
+
+.. toctree::
+   :caption: Remote Functions
+   :maxdepth: 1
+
+   Remote Function <../notebooks/remote_functions/remote_function.ipynb>
+   Remote Function Usecases <../notebooks/remote_functions/remote_function_usecases.ipynb>
+   Remote Function Vertex Claude Model <../notebooks/remote_functions/remote_function_vertex_claude_model.ipynb>
+
+.. toctree::
+   :caption: Streaming
+   :maxdepth: 1
+
+   Streaming Dataframe <../notebooks/streaming/streaming_dataframe.ipynb>
+
+.. toctree::
+   :caption: Experimental
+   :maxdepth: 1
+
+   AI Operators <../notebooks/experimental/ai_operators.ipynb>
+   Semantic Operators <../notebooks/experimental/semantic_operators.ipynb>
+
+.. toctree::
+   :caption: Apps
+   :maxdepth: 1
+
+   Synthetic Data Generation <../notebooks/apps/synthetic_data_generation.ipynb>
+
+.. toctree::
+   :caption: Kaggle
+   :maxdepth: 1
+
+   AI Forecast <../notebooks/kaggle/bq_dataframes_ai_forecast.ipynb>
+   Describe Product Images <../notebooks/kaggle/describe-product-images-with-bigframes-multimodal.ipynb>
+   Vector Search Over National Jukebox <../notebooks/kaggle/vector-search-with-bigframes-over-national-jukebox.ipynb>

notebooks/dataframes/dataframe.ipynb

@@ -49,7 +49,7 @@
    "id": "13861abc-120c-4db6-ad0c-e414b85d3443",
    "metadata": {},
    "source": [
-    "### Select a subset of the DF"
+    "## Select a subset of the DF"
    ]
   },
   {

notebooks/dataframes/index_col_null.ipynb

@@ -358,7 +358,7 @@
    "id": "13861abc-120c-4db6-ad0c-e414b85d3443",
    "metadata": {},
    "source": [
-    "### Select a subset of the DataFrame\n",
+    "## Select a subset of the DataFrame",
     "\n",
     "Filter columns by selecting a list of columns from the DataFrame.\n",
     "\n",

notebooks/experimental/ai_operators.ipynb

@@ -1,5 +1,13 @@
 {
   "cells": [
+    {
+      "cell_type": "markdown",
+      "id": "title-cell",
+      "metadata": {},
+      "source": [
+        "# AI Operators (Experimental)"
+      ]
+    },
     {
       "cell_type": "code",
       "execution_count": 1,

notebooks/experimental/semantic_operators.ipynb

@@ -1,5 +1,13 @@
 {
   "cells": [
+    {
+      "cell_type": "markdown",
+      "id": "title-cell",
+      "metadata": {},
+      "source": [
+        "# Semantic Operators (Experimental)"
+      ]
+    },
     {
       "cell_type": "code",
       "execution_count": null,

notebooks/generative_ai/bq_dataframes_ai_forecast.ipynb

@@ -60,7 +60,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Setup"
+    "## Setup"
    ]
   },
   {