staticdocs (version 0.1)

build_site: Build complete static documentation for a package.

Description

Currently, build_site builds documentation for:
  • The package DESCRIPTION
  • Help topics
  • Vignettes
  • Demos. Must be listed in ‘demos/00index
  • README.md files

Usage

build_site(pkg = ".", ..., 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.
...
Other additional arguments passed to as.sd_package used to override package defaults.
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.