package_reference_pages: Processes reference/help files

In edgararuiz/convertsite: Converts full sites, and package documentation to Quarto

Description

Processes reference/help files

Usage

package_reference(
  pkg_folder = "",
  root_folder = here::here(),
  project_folder = "",
  reference_folder = "reference"
)

package_reference_index(
  pkg_folder = "",
  reference_folder = "reference",
  project_folder = "",
  root_folder = here::here(),
  pkg = NULL
)

package_reference_pages(
  pkg_folder = "",
  reference_folder = "reference",
  project_folder = "",
  root_folder = here::here(),
  pkg = NULL
)

Arguments

pkg_folder	Path to the package's source code
root_folder	Base target Quarto folder. Defaults to current workspace.
project_folder	Sub folder in root_folder that will be the base for the package's documentation.
reference_folder	Sub folder in project_folder where the output files will land.
pkg	A pkgdown object. If one is passed, then the pkg_folder argument will be ignored

edgararuiz/convertsite documentation built on Dec. 20, 2021, 3:19 a.m.