Render an R package’s reference documentation for Sphinx

render_sphinx(path = ".", docs_dir = "docs", reference_dir = "reference", include = c("exports", "all"), clean = TRUE, quiet = FALSE)

Parse the package’s generated man/*.Rd files and write semantic reStructuredText pages understood by the bundled Sphinx R domain.

Arguments:

• path – Path to an R package source directory.

• docs_dir – Sphinx source directory, relative to path by default.

• reference_dir – Directory below docs_dir for generated reference pages.

• include – Either "exports" to document exported objects plus package and data topics, or "all" to document every Rd topic.

• clean – Remove previously generated reference pages before rendering.

• quiet – Suppress the summary message.

Returns:

Invisibly, a character vector of generated files.