From 6e45ce91b4aae337be980a483ede17d257ae92e5 Mon Sep 17 00:00:00 2001
From: Hangfei Lin <hnlin@linkedin.com>
Date: Fri, 29 Apr 2022 11:23:13 -0700
Subject: [PATCH] [feathr] Update python docs

---
 docs/dev_guide/update_python_docs.md |   4 +-
 feathr_project/docs/feathr.rst       | 151 +++++++++++++++++++++++++++
 2 files changed, 153 insertions(+), 2 deletions(-)

diff --git a/docs/dev_guide/update_python_docs.md b/docs/dev_guide/update_python_docs.md
index d43427915..ffb38583d 100644
--- a/docs/dev_guide/update_python_docs.md
+++ b/docs/dev_guide/update_python_docs.md
@@ -7,7 +7,7 @@ parent: Feathr Developer Guides
 
 ## Install Dependencis
 
-`pip install sphinx`
+`pip install sphinx &&  pip install sphinx_rtd_theme`
 
 Since `sphinx` need to run the source code to generate the documentation, make sure you have installed the all the necessary dependencies needed by the project(see setup.py files).
 
@@ -17,7 +17,7 @@ After you updated the documentation in the source code, run the following comman
 
 In docs directory:
 
-`sphinx-apidoc -f -o . ../feathr ../*setup* ../feathr/*spark_job.py*`
+`sphinx-apidoc -f -o . ../feathr ../*setup*`
 
 (excluding setup.py files and some other demo files, test files.)
 
diff --git a/feathr_project/docs/feathr.rst b/feathr_project/docs/feathr.rst
index c43f2e319..cefb8e7a4 100644
--- a/feathr_project/docs/feathr.rst
+++ b/feathr_project/docs/feathr.rst
@@ -1,9 +1,32 @@
 feathr package
 ==============
 
+Subpackages
+-----------
+
+.. toctree::
+
+    feathr.protobuf
+
 Submodules
 ----------
 
+feathr.aggregation module
+-------------------------
+
+.. automodule:: feathr.aggregation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.anchor module
+--------------------
+
+.. automodule:: feathr.anchor
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 feathr.client module
 --------------------
 
@@ -12,6 +35,134 @@ feathr.client module
     :undoc-members:
     :show-inheritance:
 
+feathr.constants module
+-----------------------
+
+.. automodule:: feathr.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.dtype module
+-------------------
+
+.. automodule:: feathr.dtype
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.feathr\_configurations module
+------------------------------------
+
+.. automodule:: feathr.feathr_configurations
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.feathr\_pyspark\_driver\_template module
+-----------------------------------------------
+
+.. automodule:: feathr.feathr_pyspark_driver_template
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.feature module
+---------------------
+
+.. automodule:: feathr.feature
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.feature\_derivations module
+----------------------------------
+
+.. automodule:: feathr.feature_derivations
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.job\_utils module
+------------------------
+
+.. automodule:: feathr.job_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.lookup\_feature module
+-----------------------------
+
+.. automodule:: feathr.lookup_feature
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.materialization\_settings module
+---------------------------------------
+
+.. automodule:: feathr.materialization_settings
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.query\_feature\_list module
+----------------------------------
+
+.. automodule:: feathr.query_feature_list
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.repo\_definitions module
+-------------------------------
+
+.. automodule:: feathr.repo_definitions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.settings module
+----------------------
+
+.. automodule:: feathr.settings
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.sink module
+------------------
+
+.. automodule:: feathr.sink
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.source module
+--------------------
+
+.. automodule:: feathr.source
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.transformation module
+----------------------------
+
+.. automodule:: feathr.transformation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+feathr.typed\_key module
+------------------------
+
+.. automodule:: feathr.typed_key
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 Module contents
 ---------------