Skip to content

Commit 2839290

Browse files
franciscojavierarceofranciscojavierarceo
authored
docs: Update Sphinx documentation (feast-dev#5553)
* chore: Updating sphinx documentation Signed-off-by: Francisco Javier Arceo <[email protected]> * chore: Updating sphinx docs Signed-off-by: Francisco Javier Arceo <[email protected]> --------- Signed-off-by: Francisco Javier Arceo <[email protected]>
1 parent 897b3f3 commit 2839290

20 files changed

+831
-618
lines changed

‎sdk/python/docs/source/feast.api.registry.rest.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ feast.api.registry.rest package
44
Submodules
55
----------
66

7+
feast.api.registry.rest.codegen\_utils module
8+
---------------------------------------------
9+
10+
.. automodule:: feast.api.registry.rest.codegen_utils
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
715
feast.api.registry.rest.data\_sources module
816
--------------------------------------------
917

@@ -36,6 +44,30 @@ feast.api.registry.rest.feature\_views module
3644
:undoc-members:
3745
:show-inheritance:
3846

47+
feast.api.registry.rest.features module
48+
---------------------------------------
49+
50+
.. automodule:: feast.api.registry.rest.features
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
feast.api.registry.rest.lineage module
56+
--------------------------------------
57+
58+
.. automodule:: feast.api.registry.rest.lineage
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
feast.api.registry.rest.metrics module
64+
--------------------------------------
65+
66+
.. automodule:: feast.api.registry.rest.metrics
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
3971
feast.api.registry.rest.permissions module
4072
------------------------------------------
4173

‎sdk/python/docs/source/feast.infra.compute_engines.algorithms.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
feast.infra.compute\_engines.algorithms package
2+
===============================================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.compute\_engines.algorithms.topo module
8+
---------------------------------------------------
9+
10+
.. automodule:: feast.infra.compute_engines.algorithms.topo
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: feast.infra.compute_engines.algorithms
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎sdk/python/docs/source/feast.infra.compute_engines.kubernetes.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
feast.infra.compute\_engines.kubernetes package
2+
===============================================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.compute\_engines.kubernetes.k8s\_engine module
8+
----------------------------------------------------------
9+
10+
.. automodule:: feast.infra.compute_engines.kubernetes.k8s_engine
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
feast.infra.compute\_engines.kubernetes.k8s\_materialization\_job module
16+
------------------------------------------------------------------------
17+
18+
.. automodule:: feast.infra.compute_engines.kubernetes.k8s_materialization_job
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
feast.infra.compute\_engines.kubernetes.k8s\_materialization\_task module
24+
-------------------------------------------------------------------------
25+
26+
.. automodule:: feast.infra.compute_engines.kubernetes.k8s_materialization_task
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
feast.infra.compute\_engines.kubernetes.main module
32+
---------------------------------------------------
33+
34+
.. automodule:: feast.infra.compute_engines.kubernetes.main
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: feast.infra.compute_engines.kubernetes
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

‎sdk/python/docs/source/feast.infra.compute_engines.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ Subpackages
77
.. toctree::
88
:maxdepth: 4
99

10+
feast.infra.compute_engines.algorithms
11+
feast.infra.compute_engines.kubernetes
1012
feast.infra.compute_engines.local
13+
feast.infra.compute_engines.snowflake
1114
feast.infra.compute_engines.spark
1215

1316
Submodules
@@ -29,6 +32,22 @@ feast.infra.compute\_engines.feature\_builder module
2932
:undoc-members:
3033
:show-inheritance:
3134

35+
feast.infra.compute\_engines.feature\_resolver module
36+
-----------------------------------------------------
37+
38+
.. automodule:: feast.infra.compute_engines.feature_resolver
39+
:members:
40+
:undoc-members:
41+
:show-inheritance:
42+
43+
feast.infra.compute\_engines.utils module
44+
-----------------------------------------
45+
46+
.. automodule:: feast.infra.compute_engines.utils
47+
:members:
48+
:undoc-members:
49+
:show-inheritance:
50+
3251
Module contents
3352
---------------
3453

‎sdk/python/docs/source/feast.infra.compute_engines.snowflake.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
feast.infra.compute\_engines.snowflake package
2+
==============================================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.compute\_engines.snowflake.snowflake\_engine module
8+
---------------------------------------------------------------
9+
10+
.. automodule:: feast.infra.compute_engines.snowflake.snowflake_engine
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
feast.infra.compute\_engines.snowflake.snowflake\_materialization\_job module
16+
-----------------------------------------------------------------------------
17+
18+
.. automodule:: feast.infra.compute_engines.snowflake.snowflake_materialization_job
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: feast.infra.compute_engines.snowflake
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎sdk/python/docs/source/feast.infra.compute_engines.spark.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,6 @@ feast.infra.compute\_engines.spark.compute module
1212
:undoc-members:
1313
:show-inheritance:
1414

15-
feast.infra.compute\_engines.spark.config module
16-
------------------------------------------------
17-
18-
.. automodule:: feast.infra.compute_engines.spark.config
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
22-
2315
feast.infra.compute\_engines.spark.feature\_builder module
2416
----------------------------------------------------------
2517

‎sdk/python/docs/source/feast.infra.mcp_servers.rst

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

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,14 @@ feast.infra.offline\_stores.file\_source module
5252
:undoc-members:
5353
:show-inheritance:
5454

55+
feast.infra.offline\_stores.hybrid\_offline\_store module
56+
---------------------------------------------------------
57+
58+
.. automodule:: feast.infra.offline_stores.hybrid_offline_store
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
5563
feast.infra.offline\_stores.ibis module
5664
---------------------------------------
5765

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Subpackages
1111
feast.infra.compute_engines
1212
feast.infra.contrib
1313
feast.infra.feature_servers
14-
feast.infra.materialization
14+
feast.infra.mcp_servers
1515
feast.infra.offline_stores
1616
feast.infra.online_stores
1717
feast.infra.registry

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
feast.lineage package
2+
=====================
3+
4+
Submodules
5+
----------
6+
7+
feast.lineage.registry\_lineage module
8+
--------------------------------------
9+
10+
.. automodule:: feast.lineage.registry_lineage
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: feast.lineage
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

0 commit comments

Comments
 (0)