Skip to content

Commit

Permalink
[feathr] Update python docs (feathr-ai#194)
Browse files Browse the repository at this point in the history
  • Loading branch information
hangfei authored Apr 29, 2022
1 parent 19bea2e commit a85479d
Show file tree
Hide file tree
Showing 2 changed files with 153 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/dev_guide/update_python_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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.)

Expand Down
151 changes: 151 additions & 0 deletions feathr_project/docs/feathr.rst
Original file line number Diff line number Diff line change
@@ -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
--------------------

Expand All @@ -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
---------------
Expand Down

0 comments on commit a85479d

Please sign in to comment.