minyeamer commented on PR #66809:
URL: https://github.com/apache/airflow/pull/66809#issuecomment-4762558981

   @jscheffl Thanks, updated this in the docs and examples in #0f5935d4.
   
   I added a short note to `airflow-core/docs/core-concepts/dags.rst` 
describing the Markdown features now rendered in Dag documentation, including 
fenced code blocks, Mermaid fences, and KaTeX display math.
   
   For `airflow-core/docs/tutorial/fundamentals.rst`, I updated the existing 
section that already references 
`airflow-core/src/airflow/example_dags/tutorial.py`. Instead of adding a 
separate tutorial example, I extended the existing `print_date` task's `doc_md` 
so the rendered Task documentation now demonstrates inline code, a fenced code 
block, KaTeX, and Mermaid while still describing the tutorial task and its 
downstream `sleep` / `templated` tasks.
   
   I also added new screenshots as `task_doc_md.png` and `dag_doc_md.png` for 
both light and dark themes. I kept the existing `task_doc.png` and 
`dag_doc.png` files untouched, since they may still be referenced elsewhere.
   
   For the Dag-level `doc_md`, I added `example_markdown_doc.py` as a small 
example Dag whose `doc_md` demonstrates the same richer Markdown rendering 
features at the Dag documentation level; this file can be included in the 
example docs as well if needed.
   
   
![task_doc_md](https://raw.githubusercontent.com/minyeamer/airflow/a3045a40384e1650f7bb92fc2b6f38947efe1533/airflow-core/docs/img/ui-light/task_doc_md.png)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to