document: Compile Rust code and generate package documentation.

Description Usage Arguments Value

View source: R/rextendr_document.R

Description

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 re-generating the package documentation.

Usage

1
document(pkg = ".", quiet = getOption("usethis.quiet", FALSE), roclets = NULL)

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 roxygen roclets option, which defaults to c("collate", "namespace", "rd").

Value

No return value, called for side effects.


rextendr documentation built on June 15, 2021, 5:06 p.m.