This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 54005f87d42 Exclude "not-ready" providers when building docs (#42873)
54005f87d42 is described below
commit 54005f87d42f9b349f7484406c858f18be04b807
Author: Kaxil Naik <[email protected]>
AuthorDate: Wed Oct 9 23:02:42 2024 +0100
Exclude "not-ready" providers when building docs (#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.
---
.../authoring-and-scheduling/{assets.rst => datasets.rst} | 0
docs/apache-airflow/authoring-and-scheduling/index.rst | 2 +-
docs/apache-airflow/templates-ref.rst | 6 +++---
docs/exts/provider_yaml_utils.py | 2 +-
4 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/apache-airflow/authoring-and-scheduling/assets.rst
b/docs/apache-airflow/authoring-and-scheduling/datasets.rst
similarity index 100%
rename from docs/apache-airflow/authoring-and-scheduling/assets.rst
rename to docs/apache-airflow/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
index 5ec94d6ca73..28cc46ab061 100644
--- 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
index 5524c82f8cc..e3de3621913 100644
--- 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
index 6e5d3a835e1..ad99da3c10e 100644
--- 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)
