Parse an rd file in to staticdocs format.

Usage

parse_rd(topic, package)

Arguments

topic
topic name, as character vector
package
package name, as character vector

Description

Rd files are pretty printed with structural elements coloured blue, and leaves are given a short prefix: \" = text, \' = verbatim, and > = R code.

Examples

parse_rd("whisker.render", "whisker")
\- Rd file (8) \- title (1) " Logicless templating \- name (1) ' whisker.render \- alias (1) ' whisker.render \- description (2) " " Logicless templating \- usage (3) > > whisker.render(template, data = parent.frame(), > partials = list(), debug = FALSE) \- arguments (16) " " \- item (2) " template \- code (1) > character " with template text " " " \- item (2) " data " named \- code (1) > list " or \- code (1) > environment " with " variables that will be used during rendering " " " \- item (2) " partials " named \- code (1) > list " with partial templates, " will be used during template construction " " " \- item (2) " debug " Used for debugging purposes, likely to " disappear " \- value (4) " " \- code (1) > character " with rendered template \- examples (5) > > template <- "Hello {{place}}!" > place <- "World" > > whisker.render(template)