Build complete static documentation for a package.

Usage

build_site(pkg = ".", site_path = "inst/web", examples = TRUE,
  templates_path = "inst/staticdocs/templates",
  bootstrap_path = "inst/staticdocs/bootstrap", mathjax = TRUE,
  with_vignettes = TRUE, with_demos = TRUE, with_readme = TRUE,
  launch = interactive())

Arguments

pkg

path to source version of package. See as.package for details on how paths and package names are resolved.

site_path

root Directory in which to create documentation.

examples

Run examples?

templates_path

Path in which to look for templates. If this doesn't exist will look next in pkg/inst/staticdocs/templates, then in staticdocs itself.

bootstrap_path

Path in which to look for bootstrap files. If this doesn't exist, will use files built into staticdocs.

mathjax

Use mathjax to render math symbols?

with_vignettes

If TRUE, will build vignettes.

with_demos

If TRUE, will build demos.

with_readme

If TRUE, will build the README.

launch

If TRUE, will open freshly generated site in web browser.

Examples

## Not run: ------------------------------------
# build_site()
## ---------------------------------------------