build_articles

< Back to Reference | View source

build_articles()

Build Articles for Documentation Site

Usage

build_articles(pkg = ".", quiet = FALSE)

Arguments

Argument Description
pkg Path to package root
quiet Suppress messages

Value

Invisibly returns paths to created files

Description

Processes articles for the documentation website. Articles are distinct from R package vignettes - they are website-only content that is NOT registered with R and will NOT be built by R CMD check.

Articles should be placed in vignettes/articles/ directory to keep them separate from actual R vignettes. Build articles from vignettes/articles directory