docs: Add sphinx api docs for aggregation, dbt, and openlineage packages (#6271)

korbonits · claude · web-flow · commit 858c01263abd · 2026-04-14T10:17:07.000+05:30
* docs: add sphinx api docs for aggregation, dbt, openlineage packages

Add missing RST files for feast.aggregation (including tiling sub-package),
feast.dbt, and feast.openlineage. Also add feast.diff.apply_progress which
was missing from feast.diff.rst. Update feast.rst toctree to include all
three new top-level packages.

Co-Authored-By: Claude Sonnet 4.6 &lt;noreply@anthropic.com&gt;
Signed-off-by: Alex Korbonits &lt;alex@korbonits.com&gt;

* docs: fix sphinx warnings from new package documentation

No new warning categories are introduced by adding feast.aggregation,
feast.dbt, and feast.openlineage to the Sphinx docs. The 10 new
"more than one target found" warnings follow the same pre-existing
pattern (8 already present) caused by feast.__init__ re-exporting
classes under multiple paths.

Fixes applied:
- Remove :undoc-members: from dataclass automodules (Aggregation,
  IRMetadata, OpenLineageConfig) to prevent duplicate attribute docs
- Document re-exporting __init__ packages at package level only to
  avoid duplicate descriptions from submodule entries
- Fix markdown-style code fences in openlineage/__init__.py docstring
- Fix RST formatting in client.py Example section (Example::) and
  emitter.py ASCII art diagram (literal block)
- Fix repo_config.py field docstring that triggered an ambiguous
  OpenLineageConfig cross-reference

Co-Authored-By: Claude Sonnet 4.6 &lt;noreply@anthropic.com&gt;
Signed-off-by: Alex Korbonits &lt;alex@korbonits.com&gt;

---------

Signed-off-by: Alex Korbonits &lt;alex@korbonits.com&gt;
Co-authored-by: Claude Sonnet 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/sdk/python/docs/source/feast.aggregation.rst b/sdk/python/docs/source/feast.aggregation.rst
@@ -0,0 +1,17 @@
+feast.aggregation package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   feast.aggregation.tiling
+
+Module contents
+---------------
+
+.. automodule:: feast.aggregation
+   :members:
+   :show-inheritance:
diff --git a/sdk/python/docs/source/feast.aggregation.tiling.rst b/sdk/python/docs/source/feast.aggregation.tiling.rst
@@ -0,0 +1,9 @@
+feast.aggregation.tiling package
+=================================
+
+Module contents
+---------------
+
+.. automodule:: feast.aggregation.tiling
+   :members:
+   :show-inheritance:
diff --git a/sdk/python/docs/source/feast.dbt.rst b/sdk/python/docs/source/feast.dbt.rst
@@ -0,0 +1,37 @@
+feast.dbt package
+=================
+
+Submodules
+----------
+
+feast.dbt.codegen module
+------------------------
+
+.. automodule:: feast.dbt.codegen
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+feast.dbt.mapper module
+-----------------------
+
+.. automodule:: feast.dbt.mapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+feast.dbt.parser module
+-----------------------
+
+.. automodule:: feast.dbt.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: feast.dbt
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/sdk/python/docs/source/feast.diff.rst b/sdk/python/docs/source/feast.diff.rst
@@ -4,6 +4,14 @@ feast.diff package
 Submodules
 ----------
 
+feast.diff.apply\_progress module
+----------------------------------
+
+.. automodule:: feast.diff.apply_progress
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 feast.diff.infra\_diff module
 -----------------------------
 
diff --git a/sdk/python/docs/source/feast.openlineage.rst b/sdk/python/docs/source/feast.openlineage.rst
@@ -0,0 +1,9 @@
+feast.openlineage package
+=========================
+
+Module contents
+---------------
+
+.. automodule:: feast.openlineage
+   :members:
+   :show-inheritance:
diff --git a/sdk/python/docs/source/feast.rst b/sdk/python/docs/source/feast.rst
@@ -7,13 +7,16 @@ Subpackages
 .. toctree::
    :maxdepth: 4
 
+   feast.aggregation
    feast.api
    feast.cli
+   feast.dbt
    feast.diff
    feast.dqm
    feast.embedded_go
    feast.infra
    feast.lineage
+   feast.openlineage
    feast.permissions
    feast.protos
    feast.transformation
@@ -22,14 +25,6 @@ Subpackages
 Submodules
 ----------
 
-feast.aggregation module
-------------------------
-
-.. automodule:: feast.aggregation
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 feast.arrow\_error\_handler module
 ----------------------------------
 
diff --git a/sdk/python/feast/openlineage/__init__.py b/sdk/python/feast/openlineage/__init__.py
@@ -35,27 +35,27 @@
 Usage:
     Simply configure OpenLineage in your feature_store.yaml:
 
-    ```yaml
-    project: my_project
-    # ... other config ...
-
-    openlineage:
-      enabled: true
-      transport_type: http
-      transport_url: http://localhost:5000
-      transport_endpoint: api/v1/lineage
-      namespace: my_namespace  # Optional: defaults to project name
-    ```
+    .. code-block:: yaml
+
+        project: my_project
+        # ... other config ...
+
+        openlineage:
+          enabled: true
+          transport_type: http
+          transport_url: http://localhost:5000
+          transport_endpoint: api/v1/lineage
+          namespace: my_namespace  # Optional: defaults to project name
 
     Then use Feast normally - lineage events are emitted automatically!
 
-    ```python
-    from feast import FeatureStore
+    .. code-block:: python
+
+        from feast import FeatureStore
 
-    fs = FeatureStore(repo_path="feature_repo")
-    fs.apply([entity, feature_view, feature_service])  # Emits lineage
-    fs.materialize(start, end)  # Emits START/COMPLETE/FAIL events
-    ```
+        fs = FeatureStore(repo_path="feature_repo")
+        fs.apply([entity, feature_view, feature_service])  # Emits lineage
+        fs.materialize(start, end)  # Emits START/COMPLETE/FAIL events
 """
 
 from feast.openlineage.client import FeastOpenLineageClient
diff --git a/sdk/python/feast/openlineage/client.py b/sdk/python/feast/openlineage/client.py
@@ -55,7 +55,8 @@ class FeastOpenLineageClient:
     from Feast operations like materialization, feature retrieval, and
     registry changes.
 
-    Example:
+    Example::
+
         from feast.openlineage import FeastOpenLineageClient, OpenLineageConfig
 
         config = OpenLineageConfig(
diff --git a/sdk/python/feast/openlineage/emitter.py b/sdk/python/feast/openlineage/emitter.py
@@ -644,11 +644,13 @@ def emit_apply(
         1. feast_feature_views_{project}: DataSources + Entities → FeatureViews
         2. feast_feature_services_{project}: FeatureViews → FeatureServices
 
-        This creates a lineage graph matching Feast UI:
+        This creates a lineage graph matching Feast UI::
+
             DataSource ──→ FeatureView ──→ FeatureService
                  ↑
               Entity
 
+
         Args:
             objects: List of Feast objects being applied
             project: Project name
diff --git a/sdk/python/feast/repo_config.py b/sdk/python/feast/repo_config.py
@@ -337,7 +337,7 @@ class RepoConfig(FeastBaseModel):
     """ MaterializationConfig: Configuration options for feature materialization behavior. """
 
     openlineage_config: Optional[OpenLineageConfig] = Field(None, alias="openlineage")
-    """ OpenLineageConfig: Configuration for OpenLineage data lineage integration (optional). """
+    """ Configuration for OpenLineage data lineage integration (optional). """
 
     def __init__(self, **data: Any):
         super().__init__(**data)
