Tool: Generate package documentation

Generate package documentation using devtools::document(). This runs roxygen2 on the package to create/update man pages and NAMESPACE.

Usage

btw_tool_pkg_document(pkg = ".", `_intent` = "")

Arguments

pkg

Path to package directory. Defaults to ".". Must be within current working directory.

_intent

An optional string describing the intent of the tool use. When the tool is used by an LLM, the model will use this argument to explain why it called the tool.

Value

The output from devtools::document().

See also

btw_tools()

Other pkg tools: btw_tool_pkg_check(), btw_tool_pkg_coverage(), btw_tool_pkg_test()