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.

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

Generate "Release Notes" in official documentation #842

Merged
merged 3 commits into from
Sep 30, 2019

Conversation

HyukjinKwon
Copy link
Member

@HyukjinKwon HyukjinKwon commented Sep 28, 2019

This PR proposes to generate "Release Notes" from https://github.com/databricks/koalas/releases
Basically, it gets the release MD text from the URL, converts it into rst file via pandoc (with pypandoc).

Reference: https://pandas.pydata.org/pandas-docs/stable/whatsnew/index.html#

Seems like working fine as below:

Screen Shot 2019-09-29 at 2 06 20 AM

Screen Shot 2019-09-29 at 2 06 26 AM

@HyukjinKwon HyukjinKwon requested review from ueshin and rxin September 28, 2019 17:16
docs/Makefile Outdated Show resolved Hide resolved
release_file.write("\n")


def download_pandoc_if_needed(path):
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole function was basically just ported from pypandoc with some minor changes, in order to:

  1. check if already downloaded
  2. to patch https://github.com/bebraw/pypandoc/pull/154

@codecov-io
Copy link

codecov-io commented Sep 29, 2019

Codecov Report

Merging #842 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #842   +/-   ##
=======================================
  Coverage   94.31%   94.31%           
=======================================
  Files          32       32           
  Lines        5930     5930           
=======================================
  Hits         5593     5593           
  Misses        337      337

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 7ee2a8d...bf4d78c. Read the comment docs.

@softagram-bot
Copy link

Softagram Impact Report for pull/842 (head commit: bf4d78c)

⭐ Change Overview

Showing the changed files, dependency changes and the impact - click for full size
(Open in Softagram Desktop for full details)

📄 Full report

Impact Report explained. Give feedback on this report to [email protected]

Copy link
Collaborator

@ueshin ueshin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

@HyukjinKwon
Copy link
Member Author

Thanks! For 10 minutes koalas as a doc, I will do it in a separate PR @ueshin!

@HyukjinKwon HyukjinKwon merged commit 391df25 into databricks:master Sep 30, 2019
@HyukjinKwon HyukjinKwon deleted the generate-release-docs branch November 6, 2019 02:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants