Skip to content

Fixed: Add links to DAGRun / DAG / Task in templates-ref.rst#33013

Merged
eladkal merged 5 commits into
apache:mainfrom
fritz-astronomer:revert-33010-revert-32245-patch-8
Aug 5, 2023
Merged

Fixed: Add links to DAGRun / DAG / Task in templates-ref.rst#33013
eladkal merged 5 commits into
apache:mainfrom
fritz-astronomer:revert-33010-revert-32245-patch-8

Conversation

@fritz-astronomer

@fritz-astronomer fritz-astronomer commented Aug 1, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

Reverts #33010 , continuation of #32245

Need to figure out how to correctly refer to Airflow source code objects with .rst
The docs readme has a lovely section on the :class: reference, which I used here
https://github.com/apache/airflow/tree/main/docs#cross-referencing-syntax

uranusjr
uranusjr reviewed Aug 2, 2023
View reviewed changes
Comment thread docs/apache-airflow/templates-ref.rst Outdated
@fritz-astronomer

fritz-astronomer commented Aug 2, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

My docker segfaulted trying to run breeze, so I can't test this, again :/ but happy to make the code changes if anyone else can give it a quick eyeball
image

@fritz-astronomer
fritz-astronomer force-pushed the revert-33010-revert-32245-patch-8 branch from d7c6d6d to 4397588 Compare August 2, 2023 17:47
@fritz-astronomer
fritz-astronomer marked this pull request as ready for review August 2, 2023 17:47
@fritz-astronomer

fritz-astronomer commented Aug 3, 2023

Copy link
Copy Markdown
Contributor Author

This is good to go 👍 I was able to test with breeze. DagRun doesn't fill with a link, for some reason that isn't rendered in the Airflow Docs, but it's just a non-clickable classpath, which is fine in my book. The other links (baseoperator, task, dag) render correctly and I tested them.

I'd like to rename airflow.models.dag.DAG to just DAG, but :class:`foo <foo>` doesn't seem to work, so I'm happy shipping this as-is

@eladkal eladkal added this to the Airflow 2.7.1 milestone Aug 3, 2023
@eladkal eladkal added the type:doc-only Changelog: Doc Only label Aug 3, 2023
@uranusjr

uranusjr commented Aug 3, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

I'd like to rename airflow.models.dag.DAG to just DAG, but :class:`foo <foo>` doesn't seem to work, so I'm happy shipping this as-is

I think :class:`~airflow.models.dag.DAG` would work (the ~ at the front trims out the module path)

@fritz-astronomer
fritz-astronomer force-pushed the revert-33010-revert-32245-patch-8 branch from edb8c2d to 61ed3e4 Compare August 3, 2023 20:50
@fritz-astronomer

fritz-astronomer commented Aug 4, 2023

Copy link
Copy Markdown
Contributor Author

Made the ~ change, and tested. Ready to merge 👍

@eladkal
eladkal merged commit 7dc01d8 into apache:main Aug 5, 2023
ephraimbuddy pushed a commit that referenced this pull request Aug 8, 2023
@fritz-astronomer @ephraimbuddy
Add links to DAGRun / DAG / Task in templates-ref.rst (#33013)
a887f92 
* Revert "Revert "Add links to DAGRun / DAG / Task in templates-ref.rst (#32245)" (#33010)"

This reverts commit 9fb26db.

* PR feedback

* correct class references in Templates doc

* use short name for model link

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

Reviewers

@uranusjr uranusjr uranusjr approved these changes
@potiuk potiuk Awaiting requested review from potiuk

Assignees

No one assigned

Labels

kind:documentation type:doc-only Changelog: Doc Only

Projects

None yet

Milestone

Airflow 2.7.0

Development

Successfully merging this pull request may close these issues.

4 participants

@fritz-astronomer @uranusjr @ephraimbuddy @eladkal