package_build_documentation: Copies and/or converts files from package source into Quarto

Description Usage Arguments

View source: R/package.R

Description

Copies and/or converts files from package source into Quarto

Usage

1
2
3
4
5
6
7
8
9
package_build_documentation(
  pkg_folder = "",
  project_folder = "",
  root_folder = here::here(),
  readme = TRUE,
  news = TRUE,
  articles = TRUE,
  reference = TRUE
)

Arguments

pkg_folder

Path to the package's source code

project_folder

Sub folder in root_folder that will be the base for the package's documentation.

root_folder

Base target Quarto folder. Defaults to current workspace.

readme

Flag that indicates of the README file needs to be processed

news

Flag that indicates of the NEWS file needs to be processed

articles

Flag that indicates of the vignette files needs to be processed

reference

Flag that indicates of the help files needs to be processed


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