Skip to content

Commit f4eed30

Browse files
adchiaadchia
authored
chore: Fix RTD and update from make build-sphinx (#2715)
* [chore] Fix RTD and update from make build-sphinx Signed-off-by: Danny Chiao <[email protected]> * update Signed-off-by: Danny Chiao <[email protected]> * update Signed-off-by: Danny Chiao <[email protected]> * fix push source Signed-off-by: Danny Chiao <[email protected]> * fix push source Signed-off-by: Danny Chiao <[email protected]> * fix hierarchy Signed-off-by: Danny Chiao <[email protected]>
1 parent 9566299 commit f4eed30

17 files changed

+273
-5
lines changed

‎sdk/python/docs/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
# You can set these variables from the command line.
55
SPHINXOPTS =
6-
SPHINXBUILD = sphinx-build
6+
SPHINXBUILD = python -m sphinx
77
SPHINXPROJ = Feast
88
SOURCEDIR = source
99
BUILDDIR = build
@@ -23,7 +23,7 @@ build-api-source:
2323
cp conf.py index.rst source/
2424

2525
html: clean-html build-api-source
26-
sphinx-build -b html source html
26+
python -m sphinx -b html source html
2727

2828
# Catch-all target: route all unknown targets to Sphinx using the new
2929
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).

‎sdk/python/docs/index.rst

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,21 @@ Data Source
2121
==================
2222

2323
.. automodule:: feast.data_source
24+
:inherited-members:
2425
:members:
25-
:exclude-members: KafkaOptions, KafkaSource, KinesisOptions, KinesisSource
26+
:exclude-members: KafkaOptions, KafkaSource, KinesisOptions, KinesisSource, PushSource, RequestSource, RequestDataSource
27+
28+
Request Source
29+
------------------
30+
31+
.. automodule:: feast.data_source
32+
:members: RequestSource
33+
34+
Push Source
35+
------------------
36+
37+
.. automodule:: feast.data_source
38+
:members: PushSource
2639

2740
BigQuery Source
2841
------------------
@@ -121,6 +134,13 @@ Registry Store
121134
:members:
122135
:exclude-members: NoopRegistryStore
123136

137+
PostgreSQL Registry Store
138+
-----------------------
139+
140+
.. automodule:: feast.infra.registry_stores.contrib.postgres.registry_store
141+
:members:
142+
:noindex:
143+
124144

125145
Provider
126146
==================
@@ -243,3 +263,10 @@ PostgreSQL Online Store
243263
.. automodule:: feast.infra.online_stores.contrib.postgres
244264
:members:
245265
:noindex:
266+
267+
HBase Online Store
268+
-----------------------
269+
270+
.. automodule:: feast.infra.online_stores.contrib.hbase_online_store.hbase
271+
:members:
272+
:noindex:

‎sdk/python/docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
-e "./sdk/python/[ci]"
1+
-e ".[ci]"

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
feast.infra.offline\_stores.contrib.postgres\_offline\_store package
22
====================================================================
33

4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
feast.infra.offline_stores.contrib.postgres_offline_store.tests
11+
412
Submodules
513
----------
614

‎sdk/python/docs/source/feast.infra.offline_stores.contrib.postgres_offline_store.tests.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.postgres\_offline\_store.tests package
2+
==========================================================================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.offline\_stores.contrib.postgres\_offline\_store.tests.data\_source module
8+
--------------------------------------------------------------------------------------
9+
10+
.. automodule:: feast.infra.offline_stores.contrib.postgres_offline_store.tests.data_source
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: feast.infra.offline_stores.contrib.postgres_offline_store.tests
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
feast.infra.offline\_stores.contrib.spark\_offline\_store package
22
=================================================================
33

4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
feast.infra.offline_stores.contrib.spark_offline_store.tests
11+
412
Submodules
513
----------
614

‎sdk/python/docs/source/feast.infra.offline_stores.contrib.spark_offline_store.tests.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.spark\_offline\_store.tests package
2+
=======================================================================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.offline\_stores.contrib.spark\_offline\_store.tests.data\_source module
8+
-----------------------------------------------------------------------------------
9+
10+
.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.tests.data_source
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.tests
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Subpackages
99

1010
feast.infra.offline_stores.contrib.trino_offline_store.connectors
1111
feast.infra.offline_stores.contrib.trino_offline_store.test_config
12+
feast.infra.offline_stores.contrib.trino_offline_store.tests
1213

1314
Submodules
1415
----------

‎sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.tests.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.tests package
2+
=======================================================================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.offline\_stores.contrib.trino\_offline\_store.tests.data\_source module
8+
-----------------------------------------------------------------------------------
9+
10+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.tests.data_source
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.tests
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎sdk/python/docs/source/feast.infra.online_stores.contrib.hbase_online_store.rst

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

0 commit comments

Comments
 (0)