Skip to content

Commit 7e9e93a

Browse files
authored
docs: Add DataFrame.struct docs (#1348)
* docs: Add DataFrame.struct docs * add other * autoclass for struct accessor
1 parent 00611d4 commit 7e9e93a

File tree

4 files changed

+28
-11
lines changed

4 files changed

+28
-11
lines changed

docs/reference/bigframes.geopandas/geoseries.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ GeoSeries
88
:local:
99
:backlinks: none
1010

11-
Series
12-
------
11+
GeoSeries
12+
---------
1313

1414
.. autoclass:: bigframes.geopandas.GeoSeries
1515
:members:

docs/reference/bigframes.pandas/frame.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
DataFrame
44
=========
55

6+
.. contents:: Table of Contents
7+
:depth: 2
8+
:local:
9+
:backlinks: none
10+
11+
DataFrame
12+
---------
13+
614
.. autoclass:: bigframes.dataframe.DataFrame
715
:members:
816
:inherited-members:
@@ -18,3 +26,11 @@ Plotting handling
1826
:members:
1927
:inherited-members:
2028
:undoc-members:
29+
30+
Struct handling
31+
^^^^^^^^^^^^^^^
32+
33+
.. autoclass:: bigframes.operations.structs.StructFrameAccessor
34+
:members:
35+
:inherited-members:
36+
:undoc-members:

docs/reference/bigframes.pandas/series.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ List handling
4646
Struct handling
4747
^^^^^^^^^^^^^^^
4848

49-
.. automodule:: bigframes.operations.structs
49+
.. autoclass:: bigframes.operations.structs.StructAccessor
5050
:members:
5151
:inherited-members:
5252
:undoc-members:

docs/templates/toc.yml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,13 @@
3838
uid: bigframes.exceptions
3939
name: Core Objects
4040
- items:
41-
- name: DataFrame
42-
uid: bigframes.dataframe.DataFrame
41+
- items:
42+
- name: DataFrame
43+
uid: bigframes.dataframe.DataFrame
44+
- name: PlotAccessor
45+
uid: bigframes.operations.plotting.PlotAccessor
46+
- name: StructAccessor
47+
uid: bigframes.operations.structs.StructFrameAccessor
4348
- items:
4449
- name: DataFrameGroupBy
4550
uid: bigframes.core.groupby.DataFrameGroupBy
@@ -68,12 +73,6 @@
6873
name: Indexers
6974
- name: pandas
7075
uid: bigframes.pandas
71-
- items:
72-
- name: Plotting
73-
uid: bigframes.operations.plotting
74-
- name: PlotAccessor
75-
uid: bigframes.operations.plotting.PlotAccessor
76-
name: Plotting
7776
- items:
7877
- name: Series
7978
uid: bigframes.series.Series
@@ -83,6 +82,8 @@
8382
uid: bigframes.operations.strings.StringMethods
8483
- name: StructAccessor
8584
uid: bigframes.operations.structs.StructAccessor
85+
- name: PlotAccessor
86+
uid: bigframes.operations.plotting.PlotAccessor
8687
name: Series
8788
- name: Window
8889
uid: bigframes.core.window.Window

0 commit comments

Comments
 (0)