Name: staticdocs
Owner: metacran
Description: Generate static html documentation for an R package
Created: 2015-08-14 13:34:57.0
Updated: 2017-11-30 20:45:29.0
Pushed: 2015-08-14 17:59:30.0
Size: 417
Language: R
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
staticdocs provides a way to conveniently render R package documentation into html pages suitable for stand-alone viewing, such as on a package webpage. You can see staticdocs in action at http://staticdocs.had.co.nz/dev/: this is the output of staticdocs applied to the latest version of staticdocs.
staticdocs is not currently available from CRAN, but you can install the development version from github with:
stall.packages("devtools")
ools::install_github("hadley/staticdocs")
Attractive defaults: staticdocs uses bootstrap to provide an attractive website.
Customisable: you can override the default templates to provide alternative rendering
Flexible ways to specify the index page so you can group related functions together.
Compared to Rd2html, staticdocs:
Makes it easier to customise the output.
Runs examples, so users see both input and output.
Assumes only one package is being rendered - links to documentation in other packages are forwarded to inside-R.