Skip to content

docs: Update Sphinx documentation #5553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
franciscojavierarceo merged 2 commits into from
Aug 4, 2025
Merged

docs: Update Sphinx documentation #5553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f91587f
chore: Updating sphinx documentation
franciscojavierarceo Aug 4, 2025
a8bde57
chore: Updating sphinx docs
franciscojavierarceo Aug 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions sdk/python/docs/source/feast.api.registry.rest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ feast.api.registry.rest package
Submodules
----------

feast.api.registry.rest.codegen\_utils module
---------------------------------------------

.. automodule:: feast.api.registry.rest.codegen_utils
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.data\_sources module
--------------------------------------------

Expand Down Expand Up @@ -36,6 +44,30 @@ feast.api.registry.rest.feature\_views module
:undoc-members:
:show-inheritance:

feast.api.registry.rest.features module
---------------------------------------

.. automodule:: feast.api.registry.rest.features
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.lineage module
--------------------------------------

.. automodule:: feast.api.registry.rest.lineage
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.metrics module
--------------------------------------

.. automodule:: feast.api.registry.rest.metrics
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.permissions module
------------------------------------------

Expand Down
21 changes: 21 additions & 0 deletions sdk/python/docs/source/feast.infra.compute_engines.algorithms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
feast.infra.compute\_engines.algorithms package
===============================================

Submodules
----------

feast.infra.compute\_engines.algorithms.topo module
---------------------------------------------------

.. automodule:: feast.infra.compute_engines.algorithms.topo
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: feast.infra.compute_engines.algorithms
:members:
:undoc-members:
:show-inheritance:
45 changes: 45 additions & 0 deletions sdk/python/docs/source/feast.infra.compute_engines.kubernetes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
feast.infra.compute\_engines.kubernetes package
===============================================

Submodules
----------

feast.infra.compute\_engines.kubernetes.k8s\_engine module
----------------------------------------------------------

.. automodule:: feast.infra.compute_engines.kubernetes.k8s_engine
:members:
:undoc-members:
:show-inheritance:

feast.infra.compute\_engines.kubernetes.k8s\_materialization\_job module
------------------------------------------------------------------------

.. automodule:: feast.infra.compute_engines.kubernetes.k8s_materialization_job
:members:
:undoc-members:
:show-inheritance:

feast.infra.compute\_engines.kubernetes.k8s\_materialization\_task module
-------------------------------------------------------------------------

.. automodule:: feast.infra.compute_engines.kubernetes.k8s_materialization_task
:members:
:undoc-members:
:show-inheritance:

feast.infra.compute\_engines.kubernetes.main module
---------------------------------------------------

.. automodule:: feast.infra.compute_engines.kubernetes.main
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: feast.infra.compute_engines.kubernetes
:members:
:undoc-members:
:show-inheritance:
19 changes: 19 additions & 0 deletions sdk/python/docs/source/feast.infra.compute_engines.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ Subpackages
.. toctree::
:maxdepth: 4

feast.infra.compute_engines.algorithms
feast.infra.compute_engines.kubernetes
feast.infra.compute_engines.local
feast.infra.compute_engines.snowflake
feast.infra.compute_engines.spark

Submodules
Expand All @@ -29,6 +32,22 @@ feast.infra.compute\_engines.feature\_builder module
:undoc-members:
:show-inheritance:

feast.infra.compute\_engines.feature\_resolver module
-----------------------------------------------------

.. automodule:: feast.infra.compute_engines.feature_resolver
:members:
:undoc-members:
:show-inheritance:

feast.infra.compute\_engines.utils module
-----------------------------------------

.. automodule:: feast.infra.compute_engines.utils
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

Expand Down
29 changes: 29 additions & 0 deletions sdk/python/docs/source/feast.infra.compute_engines.snowflake.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
feast.infra.compute\_engines.snowflake package
==============================================

Submodules
----------

feast.infra.compute\_engines.snowflake.snowflake\_engine module
---------------------------------------------------------------

.. automodule:: feast.infra.compute_engines.snowflake.snowflake_engine
:members:
:undoc-members:
:show-inheritance:

feast.infra.compute\_engines.snowflake.snowflake\_materialization\_job module
-----------------------------------------------------------------------------

.. automodule:: feast.infra.compute_engines.snowflake.snowflake_materialization_job
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: feast.infra.compute_engines.snowflake
:members:
:undoc-members:
:show-inheritance:
8 changes: 0 additions & 8 deletions sdk/python/docs/source/feast.infra.compute_engines.spark.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,6 @@ feast.infra.compute\_engines.spark.compute module
:undoc-members:
:show-inheritance:

feast.infra.compute\_engines.spark.config module
------------------------------------------------

.. automodule:: feast.infra.compute_engines.spark.config
:members:
:undoc-members:
:show-inheritance:

feast.infra.compute\_engines.spark.feature\_builder module
----------------------------------------------------------

Expand Down
29 changes: 29 additions & 0 deletions sdk/python/docs/source/feast.infra.mcp_servers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
feast.infra.mcp\_servers package
================================

Submodules
----------

feast.infra.mcp\_servers.mcp\_config module
-------------------------------------------

.. automodule:: feast.infra.mcp_servers.mcp_config
:members:
:undoc-members:
:show-inheritance:

feast.infra.mcp\_servers.mcp\_server module
-------------------------------------------

.. automodule:: feast.infra.mcp_servers.mcp_server
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: feast.infra.mcp_servers
:members:
:undoc-members:
:show-inheritance:
8 changes: 8 additions & 0 deletions sdk/python/docs/source/feast.infra.offline_stores.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,14 @@ feast.infra.offline\_stores.file\_source module
:undoc-members:
:show-inheritance:

feast.infra.offline\_stores.hybrid\_offline\_store module
---------------------------------------------------------

.. automodule:: feast.infra.offline_stores.hybrid_offline_store
:members:
:undoc-members:
:show-inheritance:

feast.infra.offline\_stores.ibis module
---------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion sdk/python/docs/source/feast.infra.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Subpackages
feast.infra.compute_engines
feast.infra.contrib
feast.infra.feature_servers
feast.infra.materialization
feast.infra.mcp_servers
feast.infra.offline_stores
feast.infra.online_stores
feast.infra.registry
Expand Down
21 changes: 21 additions & 0 deletions sdk/python/docs/source/feast.lineage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
feast.lineage package
=====================

Submodules
----------

feast.lineage.registry\_lineage module
--------------------------------------

.. automodule:: feast.lineage.registry_lineage
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: feast.lineage
:members:
:undoc-members:
:show-inheritance:
16 changes: 0 additions & 16 deletions sdk/python/docs/source/feast.protos.feast.core.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,22 +68,6 @@ feast.protos.feast.core.DatastoreTable\_pb2\_grpc module
:undoc-members:
:show-inheritance:

feast.protos.feast.core.DynamoDBTable\_pb2 module
-------------------------------------------------

.. automodule:: feast.protos.feast.core.DynamoDBTable_pb2
:members:
:undoc-members:
:show-inheritance:

feast.protos.feast.core.DynamoDBTable\_pb2\_grpc module
-------------------------------------------------------

.. automodule:: feast.protos.feast.core.DynamoDBTable_pb2_grpc
:members:
:undoc-members:
:show-inheritance:

feast.protos.feast.core.Entity\_pb2 module
------------------------------------------

Expand Down
33 changes: 33 additions & 0 deletions sdk/python/docs/source/feast.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Subpackages
feast.dqm
feast.embedded_go
feast.infra
feast.lineage
feast.loaders
feast.permissions
feast.protos
Expand Down Expand Up @@ -78,6 +79,14 @@ feast.data\_source module
:undoc-members:
:show-inheritance:

feast.document\_labeling module
-------------------------------

.. automodule:: feast.document_labeling
:members:
:undoc-members:
:show-inheritance:

feast.driver\_test\_data module
-------------------------------

Expand Down Expand Up @@ -278,6 +287,14 @@ feast.proto\_json module
:undoc-members:
:show-inheritance:

feast.rag\_retriever module
---------------------------

.. automodule:: feast.rag_retriever
:members:
:undoc-members:
:show-inheritance:

feast.registry\_server module
-----------------------------

Expand Down Expand Up @@ -342,6 +359,14 @@ feast.stream\_feature\_view module
:undoc-members:
:show-inheritance:

feast.torch\_wrapper module
---------------------------

.. automodule:: feast.torch_wrapper
:members:
:undoc-members:
:show-inheritance:

feast.transformation\_server module
-----------------------------------

Expand Down Expand Up @@ -390,6 +415,14 @@ feast.value\_type module
:undoc-members:
:show-inheritance:

feast.vector\_store module
--------------------------

.. automodule:: feast.vector_store
:members:
:undoc-members:
:show-inheritance:

feast.version module
--------------------

Expand Down
Loading