document: Compile Rust code and generate package documentation.

In rextendr: Build 'Rust' Powered 'R' Packages

Compile Rust code and generate package documentation.

Description

As of rextendr 0.4.0, this function is no longer strictly necessary. Packages created with use_extendr() now include a document binary that generates R/extendr-wrappers.R as part of the normal ⁠cargo build⁠ step, so devtools::document() works directly without any rextendr-specific pre-processing. rextendr::document() is retained for backwards compatibility.

rextendr::document() updates the package documentation for an R package that uses extendr code. It is a wrapper for devtools::document().

Usage

document(pkg = ".", 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 April 18, 2026, 5:07 p.m.