Build Package Documentation from README.md

Description

Build Package Documentation from README.md

Usage

build_references(
  path,
  out_dir = file.path(getwd(), "docs/content/reference"),
  document_internal = FALSE,
  repo_root_path = find_repo_root(getwd()),
  github_info = NULL
)

Arguments

  • path: path to source Package
  • out_dir: “docs/content/reference” output directory
  • document_internal: generate pages for topics marked as internal
  • repo_root_path: character(1); repository root path or NA

Details

Topics marked as internal with keyword{internal} (@keywords internal in roxygen) will not be documented by default. To change this, set document_internal=TRUE