Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[MINOR][R][DOC] Fix R documentation generation instruction.
## What changes were proposed in this pull request? changes in R/README.md - Make step of generating SparkR document more clear. - link R/DOCUMENTATION.md from R/README.md - turn on some code syntax highlight in R/README.md ## How was this patch tested? local test Author: Kai Jiang <jiangkai@gmail.com> Closes #13488 from vectorijk/R-Readme.
- Loading branch information
Showing
2 changed files
with
20 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
# SparkR Documentation | ||
|
||
SparkR documentation is generated using in-source comments annotated using using | ||
`roxygen2`. After making changes to the documentation, to generate man pages, | ||
SparkR documentation is generated by using in-source comments and annotated by using | ||
[`roxygen2`](https://cran.r-project.org/web/packages/roxygen2/index.html). After making changes to the documentation and generating man pages, | ||
you can run the following from an R console in the SparkR home directory | ||
|
||
library(devtools) | ||
devtools::document(pkg="./pkg", roclets=c("rd")) | ||
|
||
```R | ||
library(devtools) | ||
devtools::document(pkg="./pkg", roclets=c("rd")) | ||
``` | ||
You can verify if your changes are good by running | ||
|
||
R CMD check pkg/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters