The function rextendr::document()
updates the package documentation for an
R package that uses extendr
code, taking into account any changes that were
made in the Rust code. It is a wrapper for devtools::document()
, and it
executes extendr
-specific routines before calling devtools::document()
.
Specifically, it ensures that Rust code is recompiled (when necessary) and that
up-to-date R wrappers are generated before regenerating the package documentation.
Arguments
- pkg
The package to use, can be a file path to the package or a package object. See
as.package()
for more information.- quiet
if
TRUE
suppresses output from this function.- roclets
Character vector of roclet names to use with package. The default,
NULL
, uses the roxygenroclets
option, which defaults toc("collate", "namespace", "rd")
.