Skip to contents

This function executes all steps to build the site, including rendering PDF vignettes, generating the README file, and optionally building the site documentation using `pkgdown`.

Usage

build_all(runPkgDown = FALSE, fileNamesAsLinks = TRUE)

Arguments

runPkgDown

A logical value indicating whether to run `pkgdown::build_site()` to build the site documentation. Default is `FALSE`.

A logical value indicating whether to use the titles as links in the README file. Default is `TRUE`.

Value

The function does not return a value. It is called for its side effects of executing the build steps.

Examples

if (FALSE) { # \dontrun{
build_all()
build_all(runPkgDown = TRUE)
} # }