[
https://issues.apache.org/jira/browse/SEDONA-245?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17700216#comment-17700216
]
Gregoire Leleu commented on SEDONA-245:
---------------------------------------
[~jiayu], I've never used mkdocs, not sure what the best way to integrate would
be: the R pkgdown site is generated directly to HTML from the R man pages and
the articles. They are not md files to be compiled.
Also, the articles actually run R (and Sedona) code, so they need the jars.
They aren't in the current "docs" workflow.
If you're in a hurry to release 1.4.0 I can just push the updates to the man
pages themselves and we're keeping the old "R api docs" format on the website.
> Switch R documentation to pkgdown
> ---------------------------------
>
> Key: SEDONA-245
> URL: https://issues.apache.org/jira/browse/SEDONA-245
> Project: Apache Sedona
> Issue Type: Improvement
> Reporter: Gregoire Leleu
> Priority: Major
>
> R users are increasingly getting used to pkgdown-generated documentation.
> This would lower the bar to entry for new users and help current users work
> faster
> Pkgdown automates the creation of:
> * Function reference pages
> * Articles (programming guides)
> * A getting started page
> Sparklyr is using it:
> [https://spark.rstudio.com/packages/sparklyr/latest/reference/]
> Arrow R package is a great example in the Apache ecosystem:
> [https://arrow.apache.org/docs/r/]
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
