Build Sphinx documentation for an R package

build_sphinx(path = ".", docs_dir = "docs", output_dir = "_site", builder = "html", include = c("exports", "all"), warnings_as_errors = TRUE, keep_going = TRUE, fresh = FALSE, sphinx_build = Sys.which("sphinx-build"), quiet = FALSE)

Render the package’s Rd reference pages and invoke sphinx-build.

Arguments:

  • path – Path to an R package source directory.

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

  • output_dir – Output directory, relative to path by default.

  • builder – Sphinx builder name, usually "html".

  • include – Passed to render_sphinx.

  • warnings_as_errors – Pass -W to Sphinx.

  • keep_going – Ask Sphinx to report all warnings before failing.

  • fresh – Ignore the saved Sphinx environment.

  • sphinx_build – Path to the sphinx-build executable.

  • quiet – Suppress the render summary.

Returns:

Invisibly, the normalized output directory.