Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #162

Merged
merged 2 commits into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions R/render.R
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,14 @@
#' @param profile [Quarto project
#' profile(s)](https://quarto.org/docs/projects/profiles.html) to use. Either
#' a character vector of profile names or `NULL` to use the default profile.
#' @param quarto_args Character vector of other `quarto` CLI flag pass to the
#' command. This is mainly for advanced usage, e.g it can be useful for new
#' options added to quarto CLI and not yet supported as function argument.
#' @param pandoc_args Additional command line options to pass to pandoc.
#' @param quarto_args Character vector of other `quarto` CLI arguments to append
#' to the Quarto command executed by this function. This is mainly intended for
#' advanced usage and useful for CLI arguments which are not yet mirrored in a
#' dedicated parameter of this \R function.
#' @param pandoc_args Additional command line arguments to pass on to Pandoc.
#' @param as_job Render as an RStudio background job. Default is "auto",
#' which will render individual documents normally and projects as
#' background jobs. Use the `quarto.render_as_job` R option to control
#' background jobs. Use the `quarto.render_as_job` \R option to control
#' the default globally.
#'
#' @importFrom rmarkdown relative_to
Expand Down
7 changes: 4 additions & 3 deletions man/quarto_add_extension.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions man/quarto_create_project.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions man/quarto_inspect.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 6 additions & 5 deletions man/quarto_render.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions man/quarto_use_template.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading