Skip to content

Conversation

@potiuk
Copy link
Member

@potiuk potiuk commented Jul 4, 2025

The task-sdk package did not have full integration with airflow docs:

  • did not have inventory mapping
  • did not have a way to refer to it via doc:task-sdk: directive 8 did not have a development link from the devel index

This PR fixes all that.


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

The task-sdk package did not have full integration with airflow
docs:

* did not have inventory mapping
* did not have a way to refer to it via doc:`task-sdk:` directive
8 did not have a development link from the devel index

This PR fixes all that.
@potiuk
Copy link
Member Author

potiuk commented Jul 4, 2025

One of the things this one enables is capability to refer to task-sdk docs same as all other packages - using intersphinx package reference and inventories.

This way staging for example will work - currently the link on staging has hard-coded link to a missing "live" task-sdk, where with the intersphinx reference, we can refer to "airflow's" task-sdk package and the links will be properly generated - and also verified if they exist - as relative references rather than hard-coded absolute links:

Screenshot 2025-07-04 at 21 39 51

@potiuk potiuk merged commit 244af72 into apache:main Jul 4, 2025
102 checks passed
@potiuk potiuk deleted the make-task-sdk-airflow-doc-package branch July 4, 2025 20:21
@github-actions
Copy link

github-actions bot commented Jul 4, 2025

Backport failed to create: v3-0-test. View the failure log Run details

Status Branch Result
v3-0-test Commit Link

You can attempt to backport this manually by running:

cherry_picker 244af72 v3-0-test

This should apply the commit to the v3-0-test branch and leave the commit in conflict state marking
the files that need manual conflict resolution.

After you have resolved the conflicts, you can continue the backport process by running:

cherry_picker --continue

potiuk added a commit to potiuk/airflow that referenced this pull request Jul 4, 2025
)

The task-sdk package did not have full integration with airflow
docs:

* did not have inventory mapping
* did not have a way to refer to it via doc:`task-sdk:` directive
8 did not have a development link from the devel index

This PR fixes all that.

(cherry picked from commit 244af72)
potiuk added a commit that referenced this pull request Jul 4, 2025
…52896)

The task-sdk package did not have full integration with airflow
docs:

* did not have inventory mapping
* did not have a way to refer to it via doc:`task-sdk:` directive
8 did not have a development link from the devel index

This PR fixes all that.

(cherry picked from commit 244af72)
kaxil pushed a commit that referenced this pull request Jul 7, 2025
…52896)

The task-sdk package did not have full integration with airflow
docs:

* did not have inventory mapping
* did not have a way to refer to it via doc:`task-sdk:` directive
8 did not have a development link from the devel index

This PR fixes all that.

(cherry picked from commit 244af72)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:dev-tools area:task-sdk backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch kind:documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants