chore: Build Python protos during sphinx build (#3123)

* Fix configuration for sphinx to build Python protos Signed-off-by: Felix Wang <[email protected]> * Add RTD docs Signed-off-by: Felix Wang <[email protected]> * Add back package Signed-off-by: Felix Wang <[email protected]> * Change to not use `make` Signed-off-by: Felix Wang <[email protected]> Signed-off-by: Felix Wang <[email protected]>
feast-dev · Aug 23, 2022 · 7ca4c23 · 7ca4c23
1 parent 3910a9c
commit 7ca4c23
Show file tree

Hide file tree

Showing 6 changed files with 113 additions and 16 deletions.
diff --git a/sdk/python/docs/conf.py b/sdk/python/docs/conf.py
@@ -25,6 +25,29 @@
 sys.path.insert(0, os.path.abspath("../.."))
 
 
+# -- Build protos ---------------------------------------------------------
+
+# For an unknown reason, the Python protos stopped being built correctly.
+# See https://readthedocs.org/projects/feast/builds/17686555/ for an
+# example where the Python protos did not build, which subsequently broke
+# the RTD build. In order to fix this, we manually compile the protos.
+import subprocess
+
+from pathlib import Path
+
+# cwd will be feast/sdk/python/docs/source
+cwd = Path(os.getcwd())
+
+# Change to feast/
+os.chdir(cwd.parent.parent.parent.parent)
+
+# Compile Python protos
+result = subprocess.run(["python", "setup.py", "build_python_protos", "--inplace"], capture_output=True)
+stdout = result.stdout.decode("utf-8")
+stderr = result.stderr.decode("utf-8")
+print(f"Apply stdout:\n{stdout}")
+print(f"Apply stderr:\n{stderr}")
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.

diff --git a/sdk/python/docs/source/conf.py b/sdk/python/docs/source/conf.py
@@ -25,6 +25,29 @@
 sys.path.insert(0, os.path.abspath("../.."))
 
 
+# -- Build protos ---------------------------------------------------------
+
+# For an unknown reason, the Python protos stopped being built correctly.
+# See https://readthedocs.org/projects/feast/builds/17686555/ for an
+# example where the Python protos did not build, which subsequently broke
+# the RTD build. In order to fix this, we manually compile the protos.
+import subprocess
+
+from pathlib import Path
+
+# cwd will be feast/sdk/python/docs/source
+cwd = Path(os.getcwd())
+
+# Change to feast/
+os.chdir(cwd.parent.parent.parent.parent)
+
+# Compile Python protos
+result = subprocess.run(["python", "setup.py", "build_python_protos", "--inplace"], capture_output=True)
+stdout = result.stdout.decode("utf-8")
+stderr = result.stderr.decode("utf-8")
+print(f"Apply stdout:\n{stdout}")
+print(f"Apply stderr:\n{stderr}")
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.

diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.rst
@@ -0,0 +1,37 @@
+feast.infra.offline\_stores.contrib.mssql\_offline\_store package
+=================================================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   feast.infra.offline_stores.contrib.mssql_offline_store.tests
+
+Submodules
+----------
+
+feast.infra.offline\_stores.contrib.mssql\_offline\_store.mssql module
+----------------------------------------------------------------------
+
+.. automodule:: feast.infra.offline_stores.contrib.mssql_offline_store.mssql
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+feast.infra.offline\_stores.contrib.mssql\_offline\_store.mssqlserver\_source module
+------------------------------------------------------------------------------------
+
+.. automodule:: feast.infra.offline_stores.contrib.mssql_offline_store.mssqlserver_source
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: feast.infra.offline_stores.contrib.mssql_offline_store
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/...on/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.tests.rst b/...on/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.tests.rst
@@ -0,0 +1,21 @@
+feast.infra.offline\_stores.contrib.mssql\_offline\_store.tests package
+=======================================================================
+
+Submodules
+----------
+
+feast.infra.offline\_stores.contrib.mssql\_offline\_store.tests.data\_source module
+-----------------------------------------------------------------------------------
+
+.. automodule:: feast.infra.offline_stores.contrib.mssql_offline_store.tests.data_source
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: feast.infra.offline_stores.contrib.mssql_offline_store.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.rst
@@ -8,6 +8,7 @@ Subpackages
    :maxdepth: 4
 
    feast.infra.offline_stores.contrib.athena_offline_store
+   feast.infra.offline_stores.contrib.mssql_offline_store
    feast.infra.offline_stores.contrib.postgres_offline_store
    feast.infra.offline_stores.contrib.spark_offline_store
    feast.infra.offline_stores.contrib.trino_offline_store
@@ -23,6 +24,14 @@ feast.infra.offline\_stores.contrib.athena\_repo\_configuration module
    :undoc-members:
    :show-inheritance:
 
+feast.infra.offline\_stores.contrib.mssql\_repo\_configuration module
+---------------------------------------------------------------------
+
+.. automodule:: feast.infra.offline_stores.contrib.mssql_repo_configuration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 feast.infra.offline\_stores.contrib.postgres\_repo\_configuration module
 ------------------------------------------------------------------------
 

diff --git a/sdk/python/docs/source/feast.protos.feast.serving.rst b/sdk/python/docs/source/feast.protos.feast.serving.rst
@@ -20,22 +20,6 @@ feast.protos.feast.serving.Connector\_pb2\_grpc module
    :undoc-members:
    :show-inheritance:
 
-feast.protos.feast.serving.LoggingService\_pb2 module
------------------------------------------------------
-
-.. automodule:: feast.protos.feast.serving.LoggingService_pb2
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-feast.protos.feast.serving.LoggingService\_pb2\_grpc module
------------------------------------------------------------
-
-.. automodule:: feast.protos.feast.serving.LoggingService_pb2_grpc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 feast.protos.feast.serving.ServingService\_pb2 module
 -----------------------------------------------------