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

[SEDONA-245] R include man pages + use pkgdown for package documentation #798

Merged
merged 24 commits into from
Mar 14, 2023

Conversation

gregleleu
Copy link
Contributor

Did you read the Contributor Guide?

Is this PR related to a JIRA ticket?

What changes were proposed in this PR?

  • Update to the R documentation: fix typos, group functions of the same family together
  • Add the man pages to GitHub repo: best practice in the R world, lets users install from GitHub with the help pages
  • Use pkgdown to create a nice package website with articles
  • Update the docs workflow to build the pkgdown site, removed the "generate-docs.R" file which is not needed anymore

Currently, the pkgdown site is a drop-in replacement of the previous R docs. They are buried under API > RDD > R. I believe they should be more visible.
Also, the current workflow does not run examples in the article because it does not have access to the jars. Long-term solution would be to chain workflows so that downstream workflows have access to build jars.

How was this patch tested?

Ran R CMD Check

Did this PR include necessary documentation updates?

  • Yes, I have updated the documentation update.

@jiayuasu jiayuasu added this to the sedona-1.4.0 milestone Mar 14, 2023
@jiayuasu jiayuasu merged commit a7a2581 into apache:master Mar 14, 2023
@gregleleu gregleleu deleted the r-pkgdown branch March 16, 2023 01:29
@gregleleu gregleleu restored the r-pkgdown branch March 16, 2023 01:29
@gregleleu gregleleu deleted the r-pkgdown branch March 16, 2023 01:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants