Skip to content

Commit

Permalink
[AIRFLOW-6316] Use exampleinclude directives in tutorial.rst (#6868)
Browse files Browse the repository at this point in the history
(cherry-picked from 072dab6)
  • Loading branch information
zhongjiajie authored and kaxil committed Jan 26, 2020
1 parent d658c17 commit cde7582
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,8 @@
'sphinx.ext.intersphinx',
'autoapi.extension',
'exampleinclude',
'docroles'
'docroles',
'removemarktransform',
]

autodoc_default_options = {
Expand Down
11 changes: 11 additions & 0 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,17 @@ We can add documentation for DAG or each single task. DAG documentation only sup
markdown so far and task documentation support plain text, markdown, reStructuredText,
json, yaml

.. exampleinclude:: ../airflow/example_dags/tutorial.py
:language: python
:start-after: [START documentation]
:end-before: [END documentation]

Adding DAG and Tasks documentation
----------------------------------
We can add documentation for DAG or each single task. DAG documentation only support
markdown so far and task documentation support plain text, markdown, reStructuredText,
json, yaml

.. exampleinclude:: ../airflow/example_dags/tutorial.py
:language: python
:start-after: [START documentation]
Expand Down

0 comments on commit cde7582

Please sign in to comment.