Exclude "not-ready" providers when building docs (apache#42873)

This fixes the issue we saw in https://apache-airflow.slack.com/archives/C03G9H97MM2/p1728492002477169 This PR excludes the providers that aren't ready yet for building docs.
astronomer · Oct 9, 2024 · 54005f8 · 54005f8
1 parent 35f7076
commit 54005f8
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/...rflow/authoring-and-scheduling/assets.rst → ...low/authoring-and-scheduling/datasets.rst b/...rflow/authoring-and-scheduling/assets.rst → ...low/authoring-and-scheduling/datasets.rst
diff --git a/docs/apache-airflow/authoring-and-scheduling/index.rst b/docs/apache-airflow/authoring-and-scheduling/index.rst
@@ -41,5 +41,5 @@ It's recommended that you first review the pages in :doc:`core concepts </core-c
 
     cron
     timezone
-    assets
+    Assets <datasets>
     timetable
diff --git a/docs/apache-airflow/templates-ref.rst b/docs/apache-airflow/templates-ref.rst
@@ -62,10 +62,10 @@ Variable                                    Type                  Description
 ``{{ prev_end_date_success }}``             `pendulum.DateTime`_  End date from prior successful :class:`~airflow.models.dagrun.DagRun` (if available).
                                             | ``None``
 ``{{ inlets }}``                            list                  List of inlets declared on the task.
-``{{ inlet_events }}``                      dict[str, ...]        Access past events of inlet assets. See :doc:`Assets <authoring-and-scheduling/assets>`. Added in version 2.10.
+``{{ inlet_events }}``                      dict[str, ...]        Access past events of inlet assets. See :doc:`Assets <authoring-and-scheduling/datasets>`. Added in version 2.10.
 ``{{ outlets }}``                           list                  List of outlets declared on the task.
 ``{{ outlet_events }}``                     dict[str, ...]        | Accessors to attach information to asset events that will be emitted by the current task.
-                                                                  | See :doc:`Assets <authoring-and-scheduling/assets>`. Added in version 2.10.
+                                                                  | See :doc:`Assets <authoring-and-scheduling/datasets>`. Added in version 2.10.
 ``{{ dag }}``                               DAG                   The currently running :class:`~airflow.models.dag.DAG`. You can read more about DAGs in :doc:`DAGs <core-concepts/dags>`.
 ``{{ task }}``                              BaseOperator          | The currently running :class:`~airflow.models.baseoperator.BaseOperator`. You can read more about Tasks in :doc:`core-concepts/operators`
 ``{{ macros }}``                                                  | A reference to the macros package. See Macros_ below.
@@ -90,7 +90,7 @@ Variable                                    Type                  Description
                                                                   | Added in version 2.5.
 ``{{ triggering_asset_events }}``           dict[str,             | If in a Asset Scheduled DAG, a map of Asset URI to a list of triggering :class:`~airflow.models.asset.AssetEvent`
                                             list[AssetEvent]]     | (there may be more than one, if there are multiple Assets with different frequencies).
-                                                                  | Read more here :doc:`Assets <authoring-and-scheduling/assets>`.
+                                                                  | Read more here :doc:`Assets <authoring-and-scheduling/datasets>`.
                                                                   | Added in version 2.4.
 =========================================== ===================== ===================================================================
 

diff --git a/docs/exts/provider_yaml_utils.py b/docs/exts/provider_yaml_utils.py
@@ -70,7 +70,7 @@ def load_package_data(include_suspended: bool = False) -> list[dict[str, Any]]:
         except jsonschema.ValidationError as ex:
             msg = f"Unable to parse: {provider_yaml_path}. Original error {type(ex).__name__}: {ex}"
             raise RuntimeError(msg)
-        if provider["state"] == "suspended" and not include_suspended:
+        if provider["state"] in ["suspended", "not-ready"] and not include_suspended:
             continue
         provider_yaml_dir = os.path.dirname(provider_yaml_path)
         provider["python-module"] = _filepath_to_module(provider_yaml_dir)