build_reference {pkgsite}R Documentation

Build reference section

Description

build_reference() generates reference documentation from Rd files using tools::Rd2HTML

Usage

build_reference(pkg = ".", lazy = FALSE, preview = FALSE)

Arguments

pkg Path to package
lazy Only rebuild if source is newer than destination
preview Whether to preview after building using a local server (requires the servr package)

Value

Invisible TRUE if the reference was built successfully

Examples

## Not run:
build_reference()

# Only rebuild if source is newer than destination
build_reference(lazy = TRUE)

# Preview the site after building
build_reference(preview = TRUE)

## End(Not run)

Loading...