Skip to content

Commit 1a00fdc

Browse files
achalsachals
authored
docs: Remove python docs that are not relevant and fix warnings (feast-dev#2545)
Signed-off-by: Achal Shah <achals@gmail.com>
1 parent 9664222 commit 1a00fdc

5 files changed

Lines changed: 51 additions & 120 deletions

File tree

‎sdk/python/docs/index.rst‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Feast Python API Documentation
2-
=============================
2+
==============================
33

44

55
Feature Store
@@ -52,7 +52,7 @@ Spark Source
5252
:members:
5353
:exclude-members: SparkOptions
5454

55-
Spark Source
55+
Trino Source
5656
------------------
5757

5858
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source
@@ -81,7 +81,7 @@ Feature View
8181
:members:
8282

8383
On Demand Feature View
84-
==================
84+
======================
8585

8686
.. automodule:: feast.on_demand_feature_view
8787
:members:
@@ -124,7 +124,7 @@ Provider
124124
:members:
125125

126126
Passthrough Provider
127-
------------------
127+
--------------------
128128

129129
.. automodule:: feast.infra.passthrough_provider
130130
:members:
@@ -163,31 +163,31 @@ File Offline Store
163163
:members:
164164

165165
BigQuery Offline Store
166-
------------------
166+
----------------------
167167

168168
.. automodule:: feast.infra.offline_stores.bigquery
169169
:members:
170170

171171
Redshift Offline Store
172-
------------------
172+
----------------------
173173

174174
.. automodule:: feast.infra.offline_stores.redshift
175175
:members:
176176

177177
Snowflake Offline Store
178-
------------------
178+
-----------------------
179179

180180
.. automodule:: feast.infra.offline_stores.snowflake
181181
:members:
182182

183183
Spark Offline Store
184-
------------------
184+
-------------------
185185

186186
.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark
187187
:members:
188188

189189
Trino Offline Store
190-
------------------
190+
-------------------
191191

192192
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino
193193
:members:
@@ -201,19 +201,19 @@ Online Store
201201
:members:
202202

203203
Sqlite Online Store
204-
------------------
204+
-------------------
205205

206206
.. automodule:: feast.infra.online_stores.sqlite
207207
:members:
208208

209209
Datastore Online Store
210-
------------------
210+
----------------------
211211

212212
.. automodule:: feast.infra.online_stores.datastore
213213
:members:
214214

215215
DynamoDB Online Store
216-
------------------
216+
---------------------
217217

218218
.. automodule:: feast.infra.online_stores.dynamodb
219219
:members:
@@ -222,4 +222,5 @@ Redis Online Store
222222
------------------
223223

224224
.. automodule:: feast.infra.online_stores.redis
225-
:members:
225+
:members:
226+
:noindex:

‎sdk/python/docs/source/feast.protos.feast.types.rst‎

Lines changed: 0 additions & 61 deletions
This file was deleted.

‎sdk/python/docs/source/feast.staging.rst‎

Lines changed: 0 additions & 29 deletions
This file was deleted.

‎sdk/python/docs/source/index.rst‎

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Feast Python API Documentation
2-
=============================
2+
==============================
33

44

55
Feature Store
@@ -48,10 +48,17 @@ Snowflake Source
4848
Spark Source
4949
------------------
5050

51-
.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source.SparkSource
51+
.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source
5252
:members:
5353
:exclude-members: SparkOptions
5454

55+
Trino Source
56+
------------------
57+
58+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source
59+
:members:
60+
:exclude-members: TrinoOptions
61+
5562

5663
File Source
5764
------------------
@@ -74,7 +81,7 @@ Feature View
7481
:members:
7582

7683
On Demand Feature View
77-
==================
84+
======================
7885

7986
.. automodule:: feast.on_demand_feature_view
8087
:members:
@@ -117,7 +124,7 @@ Provider
117124
:members:
118125

119126
Passthrough Provider
120-
------------------
127+
--------------------
121128

122129
.. automodule:: feast.infra.passthrough_provider
123130
:members:
@@ -156,17 +163,36 @@ File Offline Store
156163
:members:
157164

158165
BigQuery Offline Store
159-
------------------
166+
----------------------
160167

161168
.. automodule:: feast.infra.offline_stores.bigquery
162169
:members:
163170

164171
Redshift Offline Store
165-
------------------
172+
----------------------
166173

167174
.. automodule:: feast.infra.offline_stores.redshift
168175
:members:
169176

177+
Snowflake Offline Store
178+
-----------------------
179+
180+
.. automodule:: feast.infra.offline_stores.snowflake
181+
:members:
182+
183+
Spark Offline Store
184+
-------------------
185+
186+
.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark
187+
:members:
188+
189+
Trino Offline Store
190+
-------------------
191+
192+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino
193+
:members:
194+
195+
170196
Online Store
171197
==================
172198

@@ -175,19 +201,19 @@ Online Store
175201
:members:
176202

177203
Sqlite Online Store
178-
------------------
204+
-------------------
179205

180206
.. automodule:: feast.infra.online_stores.sqlite
181207
:members:
182208

183209
Datastore Online Store
184-
------------------
210+
----------------------
185211

186212
.. automodule:: feast.infra.online_stores.datastore
187213
:members:
188214

189215
DynamoDB Online Store
190-
------------------
216+
---------------------
191217

192218
.. automodule:: feast.infra.online_stores.dynamodb
193219
:members:
@@ -196,4 +222,5 @@ Redis Online Store
196222
------------------
197223

198224
.. automodule:: feast.infra.online_stores.redis
199-
:members:
225+
:members:
226+
:noindex:

‎sdk/python/docs/source/modules.rst‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)