step_build_pkgdown(...)
Arguments
... |
Arguments passed on to pkgdown::build_site
pkg Path to package.
examples Run examples?
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.
devel Use development or deployment process?If TRUE , uses lighter-weight process suitable for rapid
iteration; it will run examples and vignettes in the current process,
and will load code with pkgload::load_all() .If FALSE , will first install the package to a temporary library,
and will run all examples and vignettes in a new process.build_site() defaults to devel = FALSE so that you get high fidelity
outputs when you building the complete site; build_reference() ,
build_home() and friends default to devel = TRUE so that you can
rapidly iterate during development.
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.
install If TRUE , will install the package in a temporary library
so it is available for vignettes.
document Deprecated Use devel instead.
|
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_session_info()
,
step_setup_push_deploy()
,
step_setup_ssh()
,
step_test_ssh()
,
step_write_text_file()
Examples
#> ✔ Creating a clean tic stage configuration
#> ℹ See `?tic::dsl_get` for details
#>
#> ── tic configuration ───────────────────────────────────────────────────────────
#> ── script ───────────────────────────────────────────────────────────── stage ──
#> ▶ step_build_pkgdown()