Skip to content

Commit

Permalink
docs: Update RTD docs to include spark and trino (#2539)
Browse files Browse the repository at this point in the history
Signed-off-by: Achal Shah <[email protected]>
  • Loading branch information
achals authored Apr 14, 2022
1 parent fbdd5fc commit b342436
Show file tree
Hide file tree
Showing 20 changed files with 835 additions and 68 deletions.
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,6 @@ build-java-no-tests:
${MVN} --no-transfer-progress -Dmaven.javadoc.skip=true -Dgpg.skip -DskipUTs=true -DskipITs=true -Drevision=${REVISION} clean package

# Trino plugin

start-trino-locally:
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}
sleep 15
Expand Down
50 changes: 50 additions & 0 deletions sdk/python/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,28 @@ Redshift Source
:members:
:exclude-members: RedshiftOptions

Snowflake Source
------------------

.. automodule:: feast.infra.offline_stores.snowflake_source
:members:
:exclude-members: SnowflakeOptions

Spark Source
------------------

.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source
:members:
:exclude-members: SparkOptions

Spark Source
------------------

.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source
:members:
:exclude-members: TrinoOptions


File Source
------------------

Expand Down Expand Up @@ -85,6 +107,15 @@ Registry
:inherited-members:
:members:

Registry Store
==================

.. automodule:: feast.registry_store
:inherited-members:
:members:
:exclude-members: NoopRegistryStore


Provider
==================

Expand Down Expand Up @@ -143,6 +174,25 @@ Redshift Offline Store
.. automodule:: feast.infra.offline_stores.redshift
:members:

Snowflake Offline Store
------------------

.. automodule:: feast.infra.offline_stores.snowflake
:members:

Spark Offline Store
------------------

.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark
:members:

Trino Offline Store
------------------

.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino
:members:


Online Store
==================

Expand Down
37 changes: 37 additions & 0 deletions sdk/python/docs/source/feast.diff.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
feast.diff package
==================

Submodules
----------

feast.diff.infra\_diff module
-----------------------------

.. automodule:: feast.diff.infra_diff
:members:
:undoc-members:
:show-inheritance:

feast.diff.property\_diff module
--------------------------------

.. automodule:: feast.diff.property_diff
:members:
:undoc-members:
:show-inheritance:

feast.diff.registry\_diff module
--------------------------------

.. automodule:: feast.diff.registry_diff
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: feast.diff
:members:
:undoc-members:
:show-inheritance:
29 changes: 29 additions & 0 deletions sdk/python/docs/source/feast.dqm.profilers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
feast.dqm.profilers package
===========================

Submodules
----------

feast.dqm.profilers.ge\_profiler module
---------------------------------------

.. automodule:: feast.dqm.profilers.ge_profiler
:members:
:undoc-members:
:show-inheritance:

feast.dqm.profilers.profiler module
-----------------------------------

.. automodule:: feast.dqm.profilers.profiler
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: feast.dqm.profilers
:members:
:undoc-members:
:show-inheritance:
29 changes: 29 additions & 0 deletions sdk/python/docs/source/feast.dqm.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
feast.dqm package
=================

Subpackages
-----------

.. toctree::
:maxdepth: 4

feast.dqm.profilers

Submodules
----------

feast.dqm.errors module
-----------------------

.. automodule:: feast.dqm.errors
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: feast.dqm
:members:
:undoc-members:
:show-inheritance:
30 changes: 30 additions & 0 deletions sdk/python/docs/source/feast.infra.offline_stores.contrib.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
feast.infra.offline\_stores.contrib package
===========================================

Subpackages
-----------

.. toctree::
:maxdepth: 4

feast.infra.offline_stores.contrib.spark_offline_store
feast.infra.offline_stores.contrib.trino_offline_store

Submodules
----------

feast.infra.offline\_stores.contrib.contrib\_repo\_configuration module
-----------------------------------------------------------------------

.. automodule:: feast.infra.offline_stores.contrib.contrib_repo_configuration
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: feast.infra.offline_stores.contrib
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
feast.infra.offline\_stores.contrib.spark\_offline\_store package
=================================================================

Submodules
----------

feast.infra.offline\_stores.contrib.spark\_offline\_store.spark module
----------------------------------------------------------------------

.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark
:members:
:undoc-members:
:show-inheritance:

feast.infra.offline\_stores.contrib.spark\_offline\_store.spark\_source module
------------------------------------------------------------------------------

.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
feast.infra.offline\_stores.contrib.trino\_offline\_store.connectors package
============================================================================

Submodules
----------

feast.infra.offline\_stores.contrib.trino\_offline\_store.connectors.upload module
----------------------------------------------------------------------------------

.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.connectors.upload
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.connectors
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
feast.infra.offline\_stores.contrib.trino\_offline\_store package
=================================================================

Subpackages
-----------

.. toctree::
:maxdepth: 4

feast.infra.offline_stores.contrib.trino_offline_store.connectors
feast.infra.offline_stores.contrib.trino_offline_store.test_config

Submodules
----------

feast.infra.offline\_stores.contrib.trino\_offline\_store.trino module
----------------------------------------------------------------------

.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino
:members:
:undoc-members:
:show-inheritance:

feast.infra.offline\_stores.contrib.trino\_offline\_store.trino\_queries module
-------------------------------------------------------------------------------

.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_queries
:members:
:undoc-members:
:show-inheritance:

feast.infra.offline\_stores.contrib.trino\_offline\_store.trino\_source module
------------------------------------------------------------------------------

.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source
:members:
:undoc-members:
:show-inheritance:

feast.infra.offline\_stores.contrib.trino\_offline\_store.trino\_type\_map module
---------------------------------------------------------------------------------

.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_type_map
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
feast.infra.offline\_stores.contrib.trino\_offline\_store.test\_config package
==============================================================================

Submodules
----------

feast.infra.offline\_stores.contrib.trino\_offline\_store.test\_config.manual\_tests module
-------------------------------------------------------------------------------------------

.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.test_config.manual_tests
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.test_config
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit b342436

Please sign in to comment.