Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[AIRFLOW-6316] Use sphinx render in tutorial.rst #6868

Merged
merged 1 commit into from Dec 22, 2019
Merged

[AIRFLOW-6316] Use sphinx render in tutorial.rst #6868

merged 1 commit into from Dec 22, 2019

Conversation

zhongjiajie
Copy link
Member

Recently we hard code in tutorial.rst which
is hard to maintain, such as set_upstream
is change to shift in tutorial.py but still
in tutorial.rst. Use sphinx is a better way

Make sure you have checked all steps below.

Jira

  • My PR addresses the following Airflow Jira issues and references them in the PR title. For example, "[AIRFLOW-XXX] My Airflow PR"
    • https://issues.apache.org/jira/browse/AIRFLOW-6316
    • In case you are fixing a typo in the documentation you can prepend your commit with [AIRFLOW-XXX], code changes always need a Jira issue.
    • In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal (AIP).
    • In case you are adding a dependency, check if the license complies with the ASF 3rd Party License Policy.

Description

  • Here are some details about my PR, including screenshots of any UI changes:

Recently we hard code in tutorial.rst which
is hard to maintain, such as set_upstream
is change to shift in tutorial.py but still
in tutorial.rst. Use sphinx is a better way

@zhongjiajie zhongjiajie force-pushed the doc_tutorial_sphnix_render branch 2 times, most recently from 04a3ba5 to d8c5dc8 Compare December 21, 2019 10:32
@zhongjiajie
Copy link
Member Author

zhongjiajie commented Dec 21, 2019 •
edited

Tutorial will like below after this patch merge

@codecov-io
Copy link

codecov-io commented Dec 21, 2019 •
edited

Codecov Report

Merging #6868 into master will decrease coverage by 0.05%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6868      +/-   ##
==========================================
- Coverage   84.39%   84.33%   -0.06%     
==========================================
  Files         680      680              
  Lines       38501    38501              
==========================================
- Hits        32491    32468      -23     
- Misses       6010     6033      +23
Impacted Files Coverage Δ
airflow/example_dags/tutorial.py 100% <100%> (ø) ⬆️
airflow/kubernetes/volume_mount.py 44.44% <0%> (-55.56%) ⬇️
airflow/kubernetes/volume.py 52.94% <0%> (-47.06%) ⬇️
airflow/kubernetes/pod_launcher.py 45.25% <0%> (-46.72%) ⬇️
airflow/kubernetes/refresh_config.py 50.98% <0%> (-23.53%) ⬇️
...rflow/contrib/operators/kubernetes_pod_operator.py 78.75% <0%> (-20%) ⬇️
airflow/jobs/backfill_job.py 91.88% <0%> (+0.28%) ⬆️
airflow/hooks/dbapi_hook.py 91.73% <0%> (+0.82%) ⬆️
airflow/models/connection.py 68.78% <0%> (+0.97%) ⬆️
airflow/hooks/hive_hooks.py 77.6% <0%> (+1.52%) ⬆️
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6a5a4ef...38194ee. Read the comment docs.

@zhongjiajie zhongjiajie marked this pull request as ready for review December 21, 2019 11:51
@zhongjiajie
Copy link
Member Author

Travis-CI pre-test is green, I think this PR is ready to review, PTAL @mik-laj

@mik-laj
Copy link
Member

mik-laj commented Dec 21, 2019 •
edited

Can you add removemarktransform in extensions option in docs/conf.py file? This will make the examples clearer. it's a special extension that trim doc marker like ``# [START howto_concept]` from python code-blocks.

@zhongjiajie
Copy link
Member Author

Great suggest! It's look better!! 👍 Thanks @mik-laj

@zhongjiajie
Copy link
Member Author

Travis-CI failed due to Test mysql python 3.7, but pre-test is green, I think it's acceptable , WDYT @mik-laj

@zhongjiajie
[AIRFLOW-6316] Use sphinx render in tutorial.rst
38194ee 
Recently we hard code in tutorial.rst which
is hard to maintain, such as `set_upstream`
is change to shift in tutorial.py but still
in tutorial.rst. Use sphinx is a better way
@zhongjiajie
Copy link
Member Author

@mik-laj CI green, PTAL, thanks

@mik-laj mik-laj merged commit 072dab6 into apache:master Dec 22, 2019
@zhongjiajie
Copy link
Member Author

Thanks Kamil for merging

@zhongjiajie zhongjiajie deleted the doc_tutorial_sphnix_render branch December 22, 2019 15:23
kaxil pushed a commit that referenced this pull request Jan 23, 2020
@zhongjiajie @kaxil
[AIRFLOW-6316] Use exampleinclude directives in tutorial.rst (#6868)
d27c963 
(cherry-picked from 072dab6)
potiuk pushed a commit that referenced this pull request Jan 26, 2020
@zhongjiajie @potiuk
[AIRFLOW-6316] Use exampleinclude directives in tutorial.rst (#6868)
14e71c3 
(cherry-picked from 072dab6)
kaxil pushed a commit that referenced this pull request Jan 26, 2020
@zhongjiajie @kaxil
[AIRFLOW-6316] Use exampleinclude directives in tutorial.rst (#6868)
cde7582 
(cherry-picked from 072dab6)
kaxil pushed a commit that referenced this pull request Feb 3, 2020
@zhongjiajie @kaxil
[AIRFLOW-6316] Use exampleinclude directives in tutorial.rst (#6868)
0efc88b 
(cherry-picked from 072dab6)
galuszkak pushed a commit to FlyrInc/apache-airflow that referenced this pull request Mar 5, 2020
@zhongjiajie @galuszkak
[AIRFLOW-6316] Use exampleinclude directives in tutorial.rst (apache#…
3b47462 
…6868)

Recently we hard code in tutorial.rst which
is hard to maintain, such as `set_upstream`
is change to shift in tutorial.py but still
in tutorial.rst. Use sphinx is a better way
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@zhongjiajie @codecov-io @mik-laj