[jira] [Commented] (ARROW-5452) [R] Add documentation website (pkgdown)
[ https://issues.apache.org/jira/browse/ARROW-5452?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16852326#comment-16852326 ] Wes McKinney commented on ARROW-5452: - Yeah, for generated API docs that is fine, if we start writing prose documentation for R we should consider doing it in a common place > [R] Add documentation website (pkgdown) > --- > > Key: ARROW-5452 > URL: https://issues.apache.org/jira/browse/ARROW-5452 > Project: Apache Arrow > Issue Type: Improvement >Reporter: Neal Richardson >Assignee: Neal Richardson >Priority: Major > Labels: pull-request-available > Fix For: 0.14.0 > > Time Spent: 10m > Remaining Estimate: 0h > > pkgdown ([https://pkgdown.r-lib.org/]) is the standard for R package > documentation websites. Build this for arrow and deploy it at > https://arrow.apache.org/docs/r. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (ARROW-5452) [R] Add documentation website (pkgdown)
[ https://issues.apache.org/jira/browse/ARROW-5452?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16852262#comment-16852262 ] Neal Richardson commented on ARROW-5452: If only .Rmd was the documentation format that R used. R man pages are .Rd format, which is a flavor of TeX. I can't imagine that it's worth our trouble to reimplement everything that `pkgdown` does to parse those and crossreference across those and various other (mostly markdown) pages. Plus, the pkgdown site style is familiar to R users, just as sphinx is for Python users. It's better for the intended audience of the docs. [https://arrow.apache.org/docs/js/] and [https://arrow.apache.org/docs/java/] already exist, so it doesn't seem unreasonable to add R to that. We can (and should) have links to those other languages in the sphinx /docs/ ToC sidebar. > [R] Add documentation website (pkgdown) > --- > > Key: ARROW-5452 > URL: https://issues.apache.org/jira/browse/ARROW-5452 > Project: Apache Arrow > Issue Type: Improvement >Reporter: Neal Richardson >Assignee: Neal Richardson >Priority: Major > Fix For: 0.14.0 > > > pkgdown ([https://pkgdown.r-lib.org/]) is the standard for R package > documentation websites. Build this for arrow and deploy it at > https://arrow.apache.org/docs/r. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (ARROW-5452) [R] Add documentation website (pkgdown)
[ https://issues.apache.org/jira/browse/ARROW-5452?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16852174#comment-16852174 ] Wes McKinney commented on ARROW-5452: - I agree with [~xhochy] on this -- if it is possible to use the main Sphinx docs project that would be ideal. If there is a need to use RMarkdown we may be able to develop some scripts that process Rmd and include the generated .md files using recommonmark https://github.com/rtfd/recommonmark > [R] Add documentation website (pkgdown) > --- > > Key: ARROW-5452 > URL: https://issues.apache.org/jira/browse/ARROW-5452 > Project: Apache Arrow > Issue Type: Improvement >Reporter: Neal Richardson >Assignee: Neal Richardson >Priority: Major > Fix For: 0.14.0 > > > pkgdown ([https://pkgdown.r-lib.org/]) is the standard for R package > documentation websites. Build this for arrow and deploy it at > https://arrow.apache.org/docs/r. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (ARROW-5452) [R] Add documentation website (pkgdown)
[ https://issues.apache.org/jira/browse/ARROW-5452?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16852150#comment-16852150 ] Uwe L. Korn commented on ARROW-5452: Not sure this is the best way to go. We merged some months ago the C++ and Python documentation as there was a quite an overlap between them and it is forseeable that there will also be a lot of overlap between R, C++ and Python. While using the typical setup for each language may make it easier for contributors to contribute intially to the documentation, it will be harder for Arrow users to navigate across all documentations for specific content. > [R] Add documentation website (pkgdown) > --- > > Key: ARROW-5452 > URL: https://issues.apache.org/jira/browse/ARROW-5452 > Project: Apache Arrow > Issue Type: Improvement >Reporter: Neal Richardson >Assignee: Neal Richardson >Priority: Major > Fix For: 0.14.0 > > > pkgdown ([https://pkgdown.r-lib.org/]) is the standard for R package > documentation websites. Build this for arrow and deploy it at > https://arrow.apache.org/docs/r. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
