build_pkgdown_yml: Build _pkgdown.yml from _pkgdown.yml.rsp

View source: R/build_pkgdown_yml.R

build_pkgdown_ymlR Documentation

Build ⁠_pkgdown.yml⁠ from ⁠_pkgdown.yml.rsp⁠

Description

Build ⁠_pkgdown.yml⁠ from ⁠_pkgdown.yml.rsp⁠

Usage

build_pkgdown_yml(
  pkg = ".",
  path = "pkgdown/_pkgdown.yml.rsp",
  validate = TRUE
)

Arguments

pkg

Path to package.

path

Relative path to ‘_pkgdown.yml.rsp’.

validate

If TRUE, the YAML syntax of the ‘_pkgdown.yml’ file is validated.

Details

This function compiles ‘_pkgdown.yml.rsp’ into ‘_pkgdown.yml’, if it exists.

Value

The path to ‘_pkgdown.yml’, or NULL.


HenrikBengtsson/pkgdown.extras documentation built on Aug. 12, 2024, 7:33 p.m.