forked from feast-dev/feast
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Revert "chore: Delete generated RTD docs (feast-dev#3126)" (fe…
…ast-dev#3141) Revert "chore: Delete generated RTD docs (feast-dev#3126)" This reverts commit 9af5bc2. Signed-off-by: Felix Wang <wangfelix98@gmail.com> Signed-off-by: Felix Wang <wangfelix98@gmail.com>
- Loading branch information
1 parent
a752211
commit 3ae7650
Showing
43 changed files
with
2,628 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,201 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# Feast documentation build configuration file, created by | ||
# sphinx-quickstart on Sat Nov 30 15:06:53 2019. | ||
# | ||
# This file is execfile()d with the current directory set to its | ||
# containing dir. | ||
# | ||
# Note that not all possible configuration values are present in this | ||
# autogenerated file. | ||
# | ||
# All configuration values have a default; values that are commented out | ||
# serve to show the default. | ||
|
||
# If extensions (or modules to document with autodoc) are in another directory, | ||
# add these directories to sys.path here. If the directory is relative to the | ||
# documentation root, use os.path.abspath to make it absolute, like shown here. | ||
# | ||
import os | ||
import sys | ||
|
||
import sphinx_rtd_theme | ||
|
||
sys.path.insert(0, os.path.abspath("../../feast")) | ||
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. | ||
# | ||
# needs_sphinx = '1.0' | ||
|
||
# Add any Sphinx extension module names here, as strings. They can be | ||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
# ones. | ||
extensions = [ | ||
"sphinx.ext.doctest", | ||
"sphinx.ext.intersphinx", | ||
"sphinx.ext.todo", | ||
"sphinx.ext.coverage", | ||
"sphinx.ext.mathjax", | ||
"sphinx.ext.ifconfig", | ||
"sphinx.ext.viewcode", | ||
"sphinx.ext.githubpages", | ||
"sphinx.ext.napoleon", | ||
"sphinx.ext.autodoc", | ||
"sphinx_rtd_theme", | ||
] | ||
|
||
# Add any paths that contain templates here, relative to this directory. | ||
templates_path = ["_templates"] | ||
|
||
# The suffix(es) of source filenames. | ||
# You can specify multiple suffix as a list of string: | ||
# | ||
# source_suffix = ['.rst', '.md'] | ||
source_suffix = ".rst" | ||
|
||
# The master toctree document. | ||
master_doc = "index" | ||
|
||
# General information about the project. | ||
project = "Feast" | ||
copyright = "2021, Feast Authors" | ||
author = "Feast Authors" | ||
|
||
# The version info for the project you're documenting, acts as replacement for | ||
# |version| and |release|, also used in various other places throughout the | ||
# built documents. | ||
# | ||
# The short X.Y version. | ||
|
||
# TODO: Add the below versions back to documentation building. | ||
# version = ( | ||
# os.popen("git describe --tags $(git rev-list --tags --max-count=1)").read().strip() | ||
# ) | ||
# The full version, including alpha/beta/rc tags. | ||
# release = ( | ||
# os.popen("git describe --tags $(git rev-list --tags --max-count=1)").read().strip() | ||
# ) | ||
|
||
# The language for content autogenerated by Sphinx. Refer to documentation | ||
# for a list of supported languages. | ||
# | ||
# This is also used if you do content translation via gettext catalogs. | ||
# Usually you set "language" from the command line for these cases. | ||
language = None | ||
|
||
# List of patterns, relative to source directory, that match files and | ||
# directories to ignore when looking for source files. | ||
# This patterns also effect to html_static_path and html_extra_path | ||
exclude_patterns = [] | ||
|
||
# The name of the Pygments (syntax highlighting) style to use. | ||
pygments_style = "sphinx" | ||
|
||
# If true, `todo` and `todoList` produce output, else they produce nothing. | ||
todo_include_todos = True | ||
|
||
|
||
# -- Options for HTML output ---------------------------------------------- | ||
|
||
# The theme to use for HTML and HTML Help pages. See the documentation for | ||
# a list of builtin themes. | ||
# | ||
html_theme = "sphinx_rtd_theme" | ||
|
||
# Theme options are theme-specific and customize the look and feel of a theme | ||
# further. For a list of options available for each theme, see the | ||
# documentation. | ||
# | ||
html_theme_options = {} | ||
|
||
# Add any paths that contain custom static files (such as style sheets) here, | ||
# relative to this directory. They are copied after the builtin static files, | ||
# so a file named "default.css" will overwrite the builtin "default.css". | ||
html_static_path = ["_static"] | ||
|
||
|
||
# -- Options for HTMLHelp output ------------------------------------------ | ||
|
||
# Output file base name for HTML help builder. | ||
htmlhelp_basename = "Feastdoc" | ||
|
||
|
||
# -- Options for LaTeX output --------------------------------------------- | ||
|
||
latex_elements = { | ||
# The paper size ('letterpaper' or 'a4paper'). | ||
# | ||
# 'papersize': 'letterpaper', | ||
# The font size ('10pt', '11pt' or '12pt'). | ||
# | ||
# 'pointsize': '10pt', | ||
# Additional stuff for the LaTeX preamble. | ||
# | ||
# 'preamble': '', | ||
# Latex figure (float) alignment | ||
# | ||
# 'figure_align': 'htbp', | ||
} | ||
|
||
# Grouping the document tree into LaTeX files. List of tuples | ||
# (source start file, target name, title, | ||
# author, documentclass [howto, manual, or own class]). | ||
latex_documents = [ | ||
(master_doc, "Feast.tex", "Feast Documentation", "Feast Authors", "manual") | ||
] | ||
|
||
|
||
# -- Options for manual page output --------------------------------------- | ||
|
||
# One entry per manual page. List of tuples | ||
# (source start file, name, description, authors, manual section). | ||
man_pages = [(master_doc, "feast", "Feast Documentation", [author], 1)] | ||
|
||
|
||
# -- Options for Texinfo output ------------------------------------------- | ||
|
||
# Grouping the document tree into Texinfo files. List of tuples | ||
# (source start file, target name, title, author, | ||
# dir menu entry, description, category) | ||
texinfo_documents = [ | ||
( | ||
master_doc, | ||
"Feast", | ||
"Feast Documentation", | ||
author, | ||
"Feast", | ||
"One line description of project.", | ||
"Miscellaneous", | ||
) | ||
] | ||
|
||
|
||
# Example configuration for intersphinx: refer to the Python standard library. | ||
intersphinx_mapping = {"https://docs.python.org/": None} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: |
29 changes: 29 additions & 0 deletions
29
sdk/python/docs/source/feast.infra.materialization.contrib.bytewax.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
feast.infra.materialization.contrib.bytewax package | ||
================================================================= | ||
|
||
Submodules | ||
---------- | ||
|
||
feast.infra.materialization.contrib.bytewax.bytewax\_materialization\_engine | ||
---------------------------------------------------------------------- | ||
|
||
.. automodule:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_engine | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
feast.infra.materialization.contrib.bytewax.bytewax\_materialization\_job | ||
---------------------------------------------------------------------- | ||
|
||
.. automodule:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_job | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: feast.infra.materialization.contrib.bytewax | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
10 changes: 10 additions & 0 deletions
10
sdk/python/docs/source/feast.infra.materialization.contrib.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
feast.infra.materialization.contrib package | ||
========================================== | ||
|
||
Subpackages | ||
----------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
feast.infra.materialization.contrib.bytewax |
29 changes: 29 additions & 0 deletions
29
sdk/python/docs/source/feast.infra.materialization.lambda.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
feast.infra.materialization.lambda package | ||
========================================== | ||
|
||
Submodules | ||
---------- | ||
|
||
feast.infra.materialization.lambda.app module | ||
--------------------------------------------- | ||
|
||
.. automodule:: feast.infra.materialization.lambda.app | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
feast.infra.materialization.lambda.lambda\_engine module | ||
-------------------------------------------------------- | ||
|
||
.. automodule:: feast.infra.materialization.lambda.lambda_engine | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: feast.infra.materialization.lambda | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Oops, something went wrong.