rdoc_style: rdoc style options

In rdoc: Colourised R Documentation

Description

Set Rd output formatting styles to be supplied to options(rdoc.style = rdoc_style())

Usage

rdoc_style(title = crayon::bold, section_titles = crayon::underline,
  arguments = NULL, code_style = prettycode::default_style())

Arguments

title	topic title.
section_titles	section titles
arguments	argument parameters.
code_style	code sections (e.g. examples) and inline code styles to be passed on to prettycode::highlight

Details

all inputs should be functions or NULL with the exception of code_style which should be a list of functions.

Value

A list

Examples

options(rdoc.style = rdoc::rdoc_style(arguments = crayon::italic))

rdoc documentation built on May 16, 2019, 5:05 p.m.