Disable pkgdown::build_llm_docs() by default

Author: jabenninghoff

NEWS.md

@@ -1,6 +1,6 @@
 # rdev 1.15.3
 
-* Minor updates
+* Updated `use_rdev_pkgdown()` to disable the new `pkgdown::build_llm_docs()` by default (update `use_rdev_pkgdown()`)
 
 # rdev 1.15.2
 

R/setup.R

@@ -685,8 +685,9 @@ use_analysis_package <- function(use_quarto = TRUE, prompt = FALSE) {
 #'   `pkgdown` to fix rendering of GitHub-style
 # nolint next: line_length_linter.
 #'   [task lists](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists),
-#'   adds the GitHub Pages URL, and enables
-#'   [`template.light-switch`](https://pkgdown.r-lib.org/articles/customise.html#light-switch).
+#'   adds the GitHub Pages URL, enables
+#'   [`template.light-switch`](https://pkgdown.r-lib.org/articles/customise.html#light-switch), and
+#'   disables [pkgdown::build_llm_docs()].
 #'
 #' @inheritParams usethis::use_pkgdown
 #'
@@ -700,6 +701,7 @@ use_rdev_pkgdown <- function(config_file = "_pkgdown.yml", destdir = "docs") {
   urls <- desc::desc_get_urls()
   pkg$url <- ifelse(!is.na(urls[2]), urls[1], ".")
   pkg$template <- append(pkg$template, list(`light-switch` = TRUE))
+  pkg$`llm-docs` <- FALSE
   # workaround for RStudio race condition
   if (rlang::is_interactive()) {
     writeLines(paste0("\nupdating ", config_file, "..."), sep = "")

R/upkeep.R

@@ -95,7 +95,6 @@ upkeep_checklist <- function(last_upkeep = last_upkeep_year()) {
       bullets,
       "### 2024",
       "",
-      todo("`rdev::use_rdev_pkgdown()`", ptype == "rdev"),
       todo("`rdev::use_analysis_package(use_quarto = FALSE)`", ptype == "analysis"),
       ""
     )
@@ -109,6 +108,7 @@ upkeep_checklist <- function(last_upkeep = last_upkeep_year()) {
       todo("`rdev::use_gitattributes()`"),
       todo("`rdev::use_analysis_package(use_quarto = TRUE)`", ptype == "quarto"),
       todo("`rdev::use_codecov()`", length(fs::dir_ls("R")) > 1),
+      todo("`rdev::use_rdev_pkgdown()", ptype == "rdev"),
       ""
     )
   }

_pkgdown.yml

@@ -2,7 +2,6 @@ url: https://jabenninghoff.github.io/rdev/
 template:
   bootstrap: 5
   light-switch: true
-
 llm-docs: false
 
 reference:

man/use_rdev_pkgdown.Rd

@@ -350,6 +350,7 @@ test_that("use_rdev_pkgdown adds customizations", {
   expect_true(fs::file_exists("pkgdown/extra.css"))
   expect_identical(pkg$template$bootstrap, 5L)
   expect_true(pkg$template$`light-switch`)
+  expect_false(pkg$`llm-docs`)
 })
 
 test_that("use_rdev_pkgdown pauses when running interactively", {

tests/testthat/test-setup.R

@@ -69,6 +69,6 @@ test_that("upkeep_checklist is expected length for last upkeep year", {
   expect_length(upkeep_checklist(2022), base_length - 6)
   expect_length(upkeep_checklist(2023), base_length - 11)
   expect_length(upkeep_checklist(2024), base_length - 16)
-  expect_length(upkeep_checklist(2025), base_length - 20)
+  expect_length(upkeep_checklist(2025), base_length - 19)
   expect_length(upkeep_checklist(2026), base_length - 25)
 })