tic (version 0.2.13.9017)

step_build_pkgdown: Step: Build pkgdown documentation

Description

Builds package documentation with the pkgdown package. Calls pkgdown::clean_site() and then pkgdown::build_site(...).

Usage

step_build_pkgdown(...)

Arguments

...

Arguments passed on to pkgdown::build_site

pkg

Path to package.

examples

Run examples?

document

If TRUE, will run devtools::document() before updating the site.

run_dont_run

Run examples that are surrounded in \dontrun?

seed

Seed used to initialize so that random examples are reproducible.

lazy

If TRUE, will only rebuild articles and reference pages if the source is newer than the destination.

override

An optional named list used to temporarily override values in _pkgdown.yml

preview

If TRUE, or is.na(preview) && interactive(), will preview freshly generated section in browser.

new_process

If TRUE, will run build_site() in a separate process. This enhances reproducibility by ensuring nothing that you have loaded in the current process affects the build process.

See Also

Other steps: step_add_to_drat, step_add_to_known_hosts, step_do_push_deploy, step_hello_world, step_install_pkg, step_install_ssh_keys, step_push_deploy, step_run_code, step_setup_push_deploy, step_setup_ssh, step_test_ssh, step_write_text_file

Examples

# NOT RUN {
dsl_init()

get_stage("script") %>%
  add_step(step_build_pkgdown())

dsl_get()
# }