Skip to content
This repository was archived by the owner on Apr 1, 2026. It is now read-only.

Commit 772f2ac

Browse files
docs: Move readme content to new User Guide section
1 parent 53428d0 commit 772f2ac

File tree

4 files changed

+39
-13
lines changed

4 files changed

+39
-13
lines changed

README.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
:orphan:
2-
31
BigQuery DataFrames (BigFrames)
42
===============================
53

4+
65
|GA| |pypi| |versions|
76

87
BigQuery DataFrames (also known as BigFrames) provides a Pythonic DataFrame

docs/conf.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@
118118
"samples/AUTHORING_GUIDE.md",
119119
"samples/CONTRIBUTING.md",
120120
"samples/snippets/README.rst",
121+
"README.rst", # used for include in overview.rst only
121122
]
122123

123124
# The reST default role (used for this markup: `text`) to use for all
@@ -163,16 +164,6 @@
163164
"logo": {
164165
"text": "BigQuery DataFrames (BigFrames)",
165166
},
166-
"external_links": [
167-
{
168-
"name": "Getting started",
169-
"url": "https://docs.cloud.google.com/bigquery/docs/dataframes-quickstart",
170-
},
171-
{
172-
"name": "User guide",
173-
"url": "https://docs.cloud.google.com/bigquery/docs/bigquery-dataframes-introduction",
174-
},
175-
],
176167
"analytics": {
177168
"google_analytics_id": "G-XVSRMCJ37X",
178169
},

docs/index.rst

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
1-
.. include:: README.rst
1+
.. BigQuery DataFrames documentation main file
2+
3+
Welcome to BigQuery DataFrames
4+
==============================
5+
6+
**BigQuery DataFrames** (``bigframes``) provides a Pythonic interface for data analysis that scales to petabytes. It gives you the best of both worlds: the familiar API of **pandas** and **scikit-learn**, powered by the distributed computing engine of **BigQuery**.
7+
8+
9+
Why BigQuery DataFrames?
10+
------------------------
11+
12+
BigFrames allows you to process data where it lives. Instead of downloading massive datasets to your local machine, BigFrames translates your Python code into SQL and executes it across the BigQuery fleet.
13+
14+
* **Scalability:** Work with datasets that exceed local memory limits.
15+
* **Efficiency:** Minimize data movement and leverage BigQuery's query optimizer.
16+
* **Familiarity:** Use ``read_gbq``, ``merge``, ``groupby``, and ``pivot_table`` just like you do in pandas.
17+
* **Integrated ML:** Access BigQuery ML (BQML) capabilities through a familiar estimator-based interface.
18+
19+
20+
User Guide
21+
----------
22+
23+
.. toctree::
24+
:maxdepth: 2
25+
26+
user_guide/index
227

328
API reference
429
-------------

docs/user_guide/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
User Guide
2+
**********
3+
4+
.. include:: ../README.rst
5+
6+
.. toctree::
7+
:caption: Guides
8+
:maxdepth: 1
9+
10+
Getting Started <https://docs.cloud.google.com/bigquery/docs/dataframes-quickstart>
11+
Cloud Docs User Guides <https://docs.cloud.google.com/bigquery/docs/bigquery-dataframes-introduction>

0 commit comments

Comments
 (0)