docs: add missing rd stuff

Author: maelle

.Rbuildignore

@@ -4,6 +4,7 @@
 ^\.github$
 ^LICENSE\.md$
 ^\.lintr$
-^man/read_yaml\.Rd$
 .ropensci-staff
 ^codemeta\.json$
+^man/filter_freeze_directory\.Rd$
+^man/read_yaml\.Rd$

DESCRIPTION

@@ -17,7 +17,7 @@ Description: Automate rendering and cross-linking of Quarto books following a
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE, roclets = c("collate", "rd", "namespace", "devtag::dev_roclet"))
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.2.9000
 Imports: 
     brio,
     cli,

R/helper-quarto.R

@@ -10,6 +10,15 @@
 #' @param placement Where to place the language links (sidebar, navbar).
 #'
 #' @return The path to the created project.
+#' @examplesIf interactive()
+#' parent_dir <- withr::local_tempdir()
+#'   quarto_multilingual_book(
+#'     parent_dir = parent_dir,
+#'     project_dir = "blop",
+#'     further_languages = c("es", "fr"),
+#'     main_language = "en"
+#'   )
+#'
 #' @export
 #'
 quarto_multilingual_book <- function(

R/register.R

@@ -3,6 +3,19 @@
 #' @param main_language Main language code (character, like `"en"`)
 #' @inheritParams render_book
 #' @return Nothing
+#' @examplesIf interactive()
+#' parent_dir <- withr::local_tempdir()
+#' quarto_multilingual_book(
+#'     parent_dir = parent_dir,
+#'     project_dir = "blop",
+#'     further_languages = c("es", "fr"),
+#'     main_language = "en",
+#'     register_languages = FALSE
+#'   )
+#' book_path <- file.path(parent_dir, "blop")
+#' register_main_language("en", book_path)
+#' # have a look at the config
+#' file.edit(file.path(parent_dir, "blop", "_quarto.yml"))
 #' @export
 register_main_language <- function(main_language = "en", project_path = ".") {
   config_path <- file.path(project_path, "_quarto.yml")
@@ -50,6 +63,17 @@ register_main_language <- function(main_language = "en", project_path = ".") {
 #' @inheritParams render_book
 #'
 #' @return Nothing
+#' @examplesIf interactive()
+#' parent_dir <- withr::local_tempdir()
+#'   quarto_multilingual_book(
+#'     parent_dir = parent_dir,
+#'     project_dir = "blop",
+#'     further_languages = c("es", "fr"),
+#'     main_language = "en"
+#'   )
+#' register_further_languages("pt", project_path = file.path(parent_dir, "blop"))
+#' # have a look at the configuration
+#' file.edit(file.path(parent_dir, "blop", "_quarto.yml"))
 #' @export
 #'
 register_further_languages <- function(further_languages, project_path = ".") {

R/render.R

@@ -24,6 +24,7 @@
 #' @param site_url Base URL of the book/website.
 #' @param profile Quarto profile(s) to use.
 #'
+#' @return Nothing, called for its side-effect of rendering a project.
 #' @export
 #'
 #' @examples

R/utils-yaml.R

@@ -1,6 +1,10 @@
 #' Alias for yaml::read_yaml with a custom handler
 #'
 #' @param path Path to yaml file
+#' @return A list
+#' @examples \dontrun{
+#' read_yaml(path)
+#' }
 #' @dev
 read_yaml <- function(path) {
   yaml::read_yaml(path, handlers = list(seq = function(x) x))