Skip to content

fix to fix-templates-doc-broken-links-60477#60507

Open
Ajay9704 wants to merge 12 commits intoapache:mainfrom
Ajay9704:fix-templates-doc-broken-links-60477
Open

fix to fix-templates-doc-broken-links-60477#60507
Ajay9704 wants to merge 12 commits intoapache:mainfrom
Ajay9704:fix-templates-doc-broken-links-60477

Conversation

@Ajay9704
Copy link
Contributor

@Ajay9704 Ajay9704 commented Jan 14, 2026

Fix broken links in templates reference documentation

The templates reference page rendered class references (e.g. DagRun, DAG, TaskInstance, BaseOperator, AssetEvent) as inline code instead of clickable links.

The issue was caused by the use of :class: roles inside table contexts, where Sphinx does not reliably resolve cross-references.

This change replaces those references with :py:class: directives, which correctly resolve and render links in tables. The fix restores functional navigation to the relevant API documentation.

Fixes #60477

@Ajay9704 Ajay9704 marked this pull request as draft January 14, 2026 09:19
@Ajay9704
Copy link
Contributor Author

Ajay9704 commented Jan 14, 2026

:class: roles were rendered as inline code inside tables; :py:class: forces proper cross-reference resolution in this context

@Ajay9704 Ajay9704 marked this pull request as ready for review January 14, 2026 10:12
@jroachgolf84
Copy link
Collaborator

@Ajay9704, I haven't seen the use of :py:obj: in the codebase before. I have seen :py:class:, however. I'd give that a shot before moving to a new pattern.

@Ajay9704
Copy link
Contributor Author

@Ajay9704, I haven't seen the use of :py:obj: in the codebase before. I have seen :py:class:, however. I'd give that a shot before moving to a new pattern.

sorry for mistake , I thought my pr is in draft mode , but forgot that I changed it , anyways I made changes accordingly by converting to :py:class:,
please review and let me know if any changes are required and thanks for your time ...

@Ajay9704
Copy link
Contributor Author

Ajay9704 commented Feb 23, 2026

@kaxil , @jroachgolf84 , @amoghrajesh , @ashb
can you please review this PR when you have some time? It’s been a while since all checks have passed, and I think it’s ready from my side,please let me know if there is anything left from my side . Thanks!

Copy link
Contributor

@amoghrajesh amoghrajesh left a comment

Choose a reason for hiding this comment

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

Can you please validate it, it makes no difference

Image

@Ajay9704
Copy link
Contributor Author

Ajay9704 commented Feb 25, 2026

Screenshot From 2026-02-25 17-10-15

@amoghrajesh , @jroachgolf84 whenever you get a moment, please review again. I’ve attached the local build screenshot that is working now.

@eladkal
Copy link
Contributor

eladkal commented Mar 13, 2026

@Ajay9704 can you rebase and resolve conflicts?

@eladkal eladkal added this to the Airflow 3.1.9 milestone Mar 13, 2026
@eladkal eladkal added type:doc-only Changelog: Doc Only backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch labels Mar 13, 2026
@eladkal eladkal requested a review from amoghrajesh March 13, 2026 06:22
@Ajay9704
Copy link
Contributor Author

@amoghrajesh @eladkal whenever you get a moment, please review again. I believe the issue is resolved from my end now.

@eladkal
Copy link
Contributor

eladkal commented Mar 19, 2026

cc @amoghrajesh any further comments?

@saikiranyt2001
Copy link

Can you please validate it, it makes no difference

Image

Hi @amoghrajesh,

Thanks for your feedback.

I revalidated this locally and confirmed that there is a difference:

  • Using :class: inside tables renders as plain inline code (not clickable)
  • Using :py:class: correctly resolves and renders clickable links

I verified this in the local docs build, and the links are now working as expected.

Could you please review again and let me know if anything still needs improvement?

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch kind:documentation type:doc-only Changelog: Doc Only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Links broken in Templates doc

5 participants