You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/01/19 13:59:25 UTC

[GitHub] [airflow] AmarEL commented on issue #13761: Markdown from doc_md is not being rendered in ui

AmarEL commented on issue #13761:
URL: https://github.com/apache/airflow/issues/13761#issuecomment-762855230


   All the examples I saw and the way that it worked for me was defining a ``__doc__`` in the very beginning of the python file that contains my DAG code and passes the value for the ``doc_md`` property.
   
   ```
   """
   ### My Python  File __doc__ section in Markdown
   Hello World.
   """
   
   dag = DAG(dag_id=dag_id, schedule_interval=schedule_interval,
                 default_args=default_args)
   dag.doc_md = __doc__
   ```
   
   https://airflow.apache.org/docs/apache-airflow/stable/tutorial.html?highlight=doc_md#adding-dag-and-tasks-documentation


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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org