| Title: | Minimal and Uncluttered Package Documentation |
|---|---|
| Description: | Generates simple and beautiful one-page HTML reference manuals with package documentation. Math rendering and syntax highlighting are done server-side in R such that no JavaScript libraries are needed in the browser, which makes the documentation portable and fast to load. |
| Authors: | Jeroen Ooms [aut, cre] |
| Maintainer: | Jeroen Ooms <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 1.3.0 |
| Built: | 2024-08-19 05:32:56 UTC |
| Source: | https://github.com/ropensci/postdoc |
Renders complete package reference manual in HTML format.
render_package_manual(package, outdir = ".", link_cb = r_universe_link) render_base_manuals(outdir = ".") r_universe_link(package)render_package_manual(package, outdir = ".", link_cb = r_universe_link) render_base_manuals(outdir = ".") r_universe_link(package)
package |
name of the package |
outdir |
where to put the html file |
link_cb |
callback function which can be used to customize hyperlinks to
other packages. This function gets invoked when a help file contains links to
another package, and should return the URL to the html reference manual for
this other package. Set to |
Math rendering and syntax highlighting are done server-side in R such that no JavaScript libraries are needed in the browser, which makes the documents portable and fast to load.
path to the generated html document
htmlfile <- render_package_manual('compiler', tempdir()) if(interactive()) utils::browseURL(htmlfile)htmlfile <- render_package_manual('compiler', tempdir()) if(interactive()) utils::browseURL(htmlfile)