build_site: Build complete static documentation for a package.

Description

Currently, build_site builds documentation for help topics, vignettes, demos, and a README.md, if present.

Usage

build_site(pkg = ".", site_path = "docs", examples = TRUE,
  run_dont_run = FALSE, templates_path = "inst/staticdocs/templates",
  bootstrap_path = "inst/staticdocs/bootstrap", mathjax = TRUE,
  with_vignettes = TRUE, with_demos = 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?

run_dont_run

Run examples that are surrounded in \dontrun?

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.

launch

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

Home page

The home page is generated from inst/staticdocs/README.md, README.md, or the DESCRIPTION if neither readme file is present. On the homepage, you should show how to install the package, describe what it does, and provide an example of how to use it.

Examples

Run this code

# NOT RUN {
build_site()
# }

Run the code above in your browser using DataCamp Workspace