Skip to content

Add missing links to airflow.sdk classes and functions in public interface docs#61005

Merged
shahar1 merged 2 commits into
apache:mainfrom
kalluripradeep:fix-public-interface-docs-links
Jan 24, 2026
Merged

Add missing links to airflow.sdk classes and functions in public interface docs#61005
shahar1 merged 2 commits into
apache:mainfrom
kalluripradeep:fix-public-interface-docs-links

Conversation

@kalluripradeep

Copy link
Copy Markdown
Contributor

Fixes #60996

Problem

The public interface documentation page had several issues:

  1. First sentence linked to TaskFlow docs instead of proper airflow.sdk namespace documentation
  2. All 15 classes listed (Asset, BaseHook, BaseOperator, etc.) had no links
  3. All 11 decorators/functions (@asset, @dag, chain, etc.) had no links

This made it difficult for DAG authors to discover the proper API documentation.

Solution

  1. Updated first sentence to link to Task SDK Reference documentation
  2. Added :class: links for all 15 classes pointing to airflow.sdk.*
  3. Added :func: links for all 11 decorators and functions pointing to airflow.sdk.*

Changes

  • Updated line 90: Changed :doc: link to proper Task SDK Reference external link
  • Lines 99-111: Added :class: Sphinx directives for all classes
  • Lines 118-128: Added :func: Sphinx directives for all decorators and functions

Testing

  • Built documentation locally to verify all links resolve correctly
  • Verified link format matches existing Task SDK documentation patterns
  • Checked that all 26 items (15 classes + 11 functions) now have working links

Related

…ons in public interface docs

- Update first sentence to link to Task SDK Reference instead of TaskFlow docs
- Add :class: links for all 15 classes (Asset, BaseHook, BaseOperator, etc.)
- Add :func: links for all 11 decorators and functions (@asset, @dag, chain, etc.)
- This improves discoverability and helps DAG authors find the correct API documentation

@shahar1 shahar1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix failing static checks

@shahar1 shahar1 changed the title Fix #60996: Add missing links to airflow.sdk classes and functions in public interface docs Add missing links to airflow.sdk classes and functions in public interface docs Jan 24, 2026
@kalluripradeep

Copy link
Copy Markdown
Contributor Author

Please fix failing static checks

@shahar1 done, Thank you

@shahar1 shahar1 merged commit 89f109b into apache:main Jan 24, 2026
71 checks passed
github-actions Bot pushed a commit that referenced this pull request Jan 24, 2026
… public interface docs (#61005)

(cherry picked from commit 89f109b)

Co-authored-by: Pradeep Kalluri <128097794+kalluripradeep@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

Backport successfully created: v3-1-test

Status Branch Result
v3-1-test PR Link

github-actions Bot pushed a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Jan 24, 2026
… public interface docs (apache#61005)

(cherry picked from commit 89f109b)

Co-authored-by: Pradeep Kalluri <128097794+kalluripradeep@users.noreply.github.com>
suii2210 pushed a commit to suii2210/airflow that referenced this pull request Jan 26, 2026
ephraimbuddy pushed a commit that referenced this pull request Jan 28, 2026
… public interface docs (#61005) (#61012)

(cherry picked from commit 89f109b)

Co-authored-by: Pradeep Kalluri <128097794+kalluripradeep@users.noreply.github.com>
shreyas-dev pushed a commit to shreyas-dev/airflow that referenced this pull request Jan 29, 2026
jhgoebbert pushed a commit to jhgoebbert/airflow_Owen-CH-Leung that referenced this pull request Feb 8, 2026
choo121600 pushed a commit to choo121600/airflow that referenced this pull request Feb 22, 2026
Subham-KRLX pushed a commit to Subham-KRLX/airflow that referenced this pull request Mar 4, 2026
Ankurdeewan pushed a commit to Ankurdeewan/airflow that referenced this pull request Mar 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Confusing Docs re: "Public Interface for DAG Authors" and No Link to Asset, etc

3 participants