francescomucio opened a new issue, #25392:
URL: https://github.com/apache/airflow/issues/25392

   ### Description
   
   Have the possibility to use `doc_md` also to indicate a  markdown ile 
containing the documentation for a DAG
   
   ### Use case/motivation
   
   Currently [it is possible to document a DAG or 
task](https://airflow.apache.org/docs/apache-airflow/stable/concepts/dags.html#dag-task-documentation)
 using `doc_md`.
   
   Sometimes these description can become quite long and pollute the DAG code, 
moreover it is not possible to preview the markdown description.
   
   A possible solution would be to have the possibility to use the `doc_md` 
also to indicate a .md file containing the documentation for the DAG.
   
   Bonus point if a dag (file name `my_dag.py`) is able to pick-up 
automatically its documentation in case a markdown file with the same name 
exists (e.g. `my_dag.md`). While this would be quite cool, it can appear as a 
sort of implicit magic, so I would like to have a few input also from the 
Airflow community.
   
   ### Related issues
   
   _No response_
   
   ### Are you willing to submit a PR?
   
   - [X] Yes I am willing to submit a PR!
   
   ### Code of Conduct
   
   - [X] I agree to follow this project's [Code of 
Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)
   


-- 
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