Skip to content

Commit

Permalink
Merge branch '1493'
Browse files Browse the repository at this point in the history
  • Loading branch information
criccomini committed May 17, 2016
2 parents 6f4696b + 1505682 commit abc43c1
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions docs/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -639,12 +639,13 @@ may look like inside your ``airflow_settings.py``:
task.timeout = timedelta(hours=48)
Task Documentation & Notes
==========================
Documentation & Notes
=====================

It's possible to add documentation or notes to your task objects that become
visible in the "Task Details" view in the web interface. There are a set
of special task attributes that get rendered as rich content if defined:
It's possible to add documentation or notes to your dags & task objects that
become visible in the web interface ("Graph View" for dags, "Task Details" for
tasks). There are a set of special task attributes that get rendered as rich
content if defined:

========== ================
attribute rendered to
Expand All @@ -656,19 +657,28 @@ doc_md markdown
doc_rst reStructuredText
========== ================

Please note that for dags, dag_md is the only attribute interpreted.

This is especially useful if your tasks are built dynamically from
configuration files, it allows you to expose the configuration that led
to the related tasks in Airflow.

.. code:: python
"""
### My great DAG
"""
dag = DAG('my_dag', default_args=default_args)
dag.doc_md = __doc__
t = BashOperator("foo", dag=dag)
t.doc_md = """\
#Title"
Here's a [url](www.airbnb.com)
"""
This content will get rendered as markdown in the "Task Details" page.
This content will get rendered as markdown respectively in the "Graph View" and
"Task Details" pages.

Jinja Templating
================
Expand Down

0 comments on commit abc43c1

Please sign in to comment.