Skip to content

Commit b342436

Browse files
achalsachals
authored
docs: Update RTD docs to include spark and trino (feast-dev#2539)
Signed-off-by: Achal Shah <achals@gmail.com>
1 parent fbdd5fc commit b342436

20 files changed

Lines changed: 835 additions & 68 deletions

‎Makefile‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,6 @@ build-java-no-tests:
123123
${MVN} --no-transfer-progress -Dmaven.javadoc.skip=true -Dgpg.skip -DskipUTs=true -DskipITs=true -Drevision=${REVISION} clean package
124124

125125
# Trino plugin
126-
127126
start-trino-locally:
128127
cd ${ROOT_DIR}; docker run --detach --rm -p 8080:8080 --name trino -v ${ROOT_DIR}/sdk/python/feast/infra/offline_stores/contrib/trino_offline_store/test_config/properties/:/etc/catalog/:ro trinodb/trino:${TRINO_VERSION}
129128
sleep 15

‎sdk/python/docs/index.rst‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,28 @@ Redshift Source
3838
:members:
3939
:exclude-members: RedshiftOptions
4040

41+
Snowflake Source
42+
------------------
43+
44+
.. automodule:: feast.infra.offline_stores.snowflake_source
45+
:members:
46+
:exclude-members: SnowflakeOptions
47+
48+
Spark Source
49+
------------------
50+
51+
.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source
52+
:members:
53+
:exclude-members: SparkOptions
54+
55+
Spark Source
56+
------------------
57+
58+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source
59+
:members:
60+
:exclude-members: TrinoOptions
61+
62+
4163
File Source
4264
------------------
4365

@@ -85,6 +107,15 @@ Registry
85107
:inherited-members:
86108
:members:
87109

110+
Registry Store
111+
==================
112+
113+
.. automodule:: feast.registry_store
114+
:inherited-members:
115+
:members:
116+
:exclude-members: NoopRegistryStore
117+
118+
88119
Provider
89120
==================
90121

@@ -143,6 +174,25 @@ Redshift Offline Store
143174
.. automodule:: feast.infra.offline_stores.redshift
144175
:members:
145176

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+
146196
Online Store
147197
==================
148198

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
feast.diff package
2+
==================
3+
4+
Submodules
5+
----------
6+
7+
feast.diff.infra\_diff module
8+
-----------------------------
9+
10+
.. automodule:: feast.diff.infra_diff
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
feast.diff.property\_diff module
16+
--------------------------------
17+
18+
.. automodule:: feast.diff.property_diff
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
feast.diff.registry\_diff module
24+
--------------------------------
25+
26+
.. automodule:: feast.diff.registry_diff
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: feast.diff
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

‎sdk/python/docs/source/feast.dqm.profilers.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
feast.dqm.profilers package
2+
===========================
3+
4+
Submodules
5+
----------
6+
7+
feast.dqm.profilers.ge\_profiler module
8+
---------------------------------------
9+
10+
.. automodule:: feast.dqm.profilers.ge_profiler
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
feast.dqm.profilers.profiler module
16+
-----------------------------------
17+
18+
.. automodule:: feast.dqm.profilers.profiler
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: feast.dqm.profilers
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
feast.dqm package
2+
=================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
feast.dqm.profilers
11+
12+
Submodules
13+
----------
14+
15+
feast.dqm.errors module
16+
-----------------------
17+
18+
.. automodule:: feast.dqm.errors
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: feast.dqm
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎sdk/python/docs/source/feast.infra.offline_stores.contrib.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
feast.infra.offline\_stores.contrib package
2+
===========================================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
feast.infra.offline_stores.contrib.spark_offline_store
11+
feast.infra.offline_stores.contrib.trino_offline_store
12+
13+
Submodules
14+
----------
15+
16+
feast.infra.offline\_stores.contrib.contrib\_repo\_configuration module
17+
-----------------------------------------------------------------------
18+
19+
.. automodule:: feast.infra.offline_stores.contrib.contrib_repo_configuration
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
Module contents
25+
---------------
26+
27+
.. automodule:: feast.infra.offline_stores.contrib
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:

‎sdk/python/docs/source/feast.infra.offline_stores.contrib.spark_offline_store.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
feast.infra.offline\_stores.contrib.spark\_offline\_store package
2+
=================================================================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.offline\_stores.contrib.spark\_offline\_store.spark module
8+
----------------------------------------------------------------------
9+
10+
.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
feast.infra.offline\_stores.contrib.spark\_offline\_store.spark\_source module
16+
------------------------------------------------------------------------------
17+
18+
.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.connectors.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
feast.infra.offline\_stores.contrib.trino\_offline\_store.connectors package
2+
============================================================================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.offline\_stores.contrib.trino\_offline\_store.connectors.upload module
8+
----------------------------------------------------------------------------------
9+
10+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.connectors.upload
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.connectors
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
feast.infra.offline\_stores.contrib.trino\_offline\_store package
2+
=================================================================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
feast.infra.offline_stores.contrib.trino_offline_store.connectors
11+
feast.infra.offline_stores.contrib.trino_offline_store.test_config
12+
13+
Submodules
14+
----------
15+
16+
feast.infra.offline\_stores.contrib.trino\_offline\_store.trino module
17+
----------------------------------------------------------------------
18+
19+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
feast.infra.offline\_stores.contrib.trino\_offline\_store.trino\_queries module
25+
-------------------------------------------------------------------------------
26+
27+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_queries
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
32+
feast.infra.offline\_stores.contrib.trino\_offline\_store.trino\_source module
33+
------------------------------------------------------------------------------
34+
35+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
40+
feast.infra.offline\_stores.contrib.trino\_offline\_store.trino\_type\_map module
41+
---------------------------------------------------------------------------------
42+
43+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_type_map
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:
47+
48+
Module contents
49+
---------------
50+
51+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:

‎sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.test_config.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
feast.infra.offline\_stores.contrib.trino\_offline\_store.test\_config package
2+
==============================================================================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.offline\_stores.contrib.trino\_offline\_store.test\_config.manual\_tests module
8+
-------------------------------------------------------------------------------------------
9+
10+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.test_config.manual_tests
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.test_config
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

0 commit comments

Comments
 (0)