diff --git a/DESCRIPTION b/DESCRIPTION index a60df11a..dbf79eec 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: rdev Title: R Development Tools -Version: 1.15.2 +Version: 1.15.3 Authors@R: person("John", "Benninghoff", , "jbenninghoff@mac.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-6230-4742")) diff --git a/NEWS.md b/NEWS.md index 367b26c2..c57817e1 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# rdev 1.15.3 + +* Updated `use_rdev_pkgdown()` to disable the new `pkgdown::build_llm_docs()` by default (update `use_rdev_pkgdown()`) + # rdev 1.15.2 * Minor updates to `upkeep_checklist()`, GitHub Actions (`missing-deps`) diff --git a/R/setup.R b/R/setup.R index 6f3083eb..2d1380db 100644 --- a/R/setup.R +++ b/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 = "") diff --git a/R/upkeep.R b/R/upkeep.R index d3afcba3..1450b104 100644 --- a/R/upkeep.R +++ b/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"), "" ) } diff --git a/README.md b/README.md index 2d87c319..d44947b0 100644 --- a/README.md +++ b/README.md @@ -234,20 +234,20 @@ ci() #> * creating vignettes ... OK #> * checking for LF line-endings in source and make files and shell scripts #> * checking for empty or unneeded directories -#> * building ‘rdev_1.15.2.tar.gz’ +#> * building ‘rdev_1.15.3.tar.gz’ #> #> ── R CMD check ───────────────────────────────────────────────────────────────── -#> * using log directory ‘/private/var/folders/vn/cw5f9gws42v9m8mdsds_zbl00000gp/T/Rtmp7I3C6H/filefe8b30a6a279/rdev.Rcheck’ -#> * using R version 4.5.1 (2025-06-13) +#> * using log directory ‘/private/var/folders/vn/cw5f9gws42v9m8mdsds_zbl00000gp/T/RtmpKqcBbC/file10fe43aa54c3d/rdev.Rcheck’ +#> * using R version 4.5.2 (2025-10-31) #> * using platform: aarch64-apple-darwin20 #> * R was compiled by #> Apple clang version 16.0.0 (clang-1600.0.26.6) #> GNU Fortran (GCC) 14.2.0 -#> * running under: macOS Sequoia 15.7.1 +#> * running under: macOS Sequoia 15.7.2 #> * using session charset: UTF-8 #> * using option ‘--no-manual’ #> * checking for file ‘rdev/DESCRIPTION’ ... OK -#> * this is package ‘rdev’ version ‘1.15.2’ +#> * this is package ‘rdev’ version ‘1.15.3’ #> * package encoding: UTF-8 #> * checking package namespace information ... OK #> * checking package dependencies ... OK @@ -300,10 +300,9 @@ ci() #> * checking package vignettes ... OK #> * checking re-building of vignette outputs ... OK #> * DONE -#> #> Status: OK -#> ── R CMD check results ──────────────────────────────────────── rdev 1.15.2 ──── -#> Duration: 24.6s +#> ── R CMD check results ──────────────────────────────────────── rdev 1.15.3 ──── +#> Duration: 25.2s #> #> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔ ``` diff --git a/TODO.md b/TODO.md index 56f8037d..429d319c 100644 --- a/TODO.md +++ b/TODO.md @@ -57,7 +57,7 @@ - [x] Replace `GITHUB_PAT` in `.Renviron` with [gitcreds](https://usethis.r-lib.org/articles/git-credentials.html) - [x] Review use of [usethis functions](https://usethis.r-lib.org/reference/index.html), including [pull request helpers](https://usethis.r-lib.org/articles/pr-functions.html) - [ ] Update tests with new testthat features (`testthat::auto_test_package()`, `testthat::describe()`, Reporters, `testthat::local_mocked_bindings()`) -- [ ] Replace `dev = TRUE` logic if is accepted +- [ ] Replace `dev = TRUE` logic after renv 1.1.6+ is released; see renv [#1695](https://github.com/rstudio/renv/issues/1695), [#2190](https://github.com/rstudio/renv/pull/2190) - [ ] Update errors and messages after reading Advanced R [Conditions](https://adv-r.hadley.nz/conditions.html) and re-reading the Tidyverse [Style Guide](https://style.tidyverse.org/index.html) - [ ] Reduce the number of Imports, per R CMD check: diff --git a/_pkgdown.yml b/_pkgdown.yml index de80323c..b14c3d8e 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -2,6 +2,7 @@ url: https://jabenninghoff.github.io/rdev/ template: bootstrap: 5 light-switch: true +llm-docs: false reference: - title: Release Automation diff --git a/docs/404.html b/docs/404.html index 6d144465..1832ea40 100644 --- a/docs/404.html +++ b/docs/404.html @@ -27,7 +27,7 @@ rdev - 1.15.2 + 1.15.3 "; + if (ClipboardJS.isSupported()) { + $(document).ready(function () { + var copyButton = ""; - $("div.sourceCode").addClass("hasCopyButton"); + $("div.sourceCode").addClass("hasCopyButton"); - // Insert copy buttons: - $(copyButton).prependTo(".hasCopyButton"); + // Insert copy buttons: + $(copyButton).prependTo(".hasCopyButton"); - // Initialize tooltips: - $('.btn-copy-ex').tooltip({container: 'body'}); + // Initialize tooltips: + $('.btn-copy-ex').tooltip({ container: 'body' }); - // Initialize clipboard: - var clipboard = new ClipboardJS('[data-clipboard-copy]', { - text: function(trigger) { - return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); - } - }); + // Initialize clipboard: + var clipboard = new ClipboardJS('[data-clipboard-copy]', { + text: function (trigger) { + return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); + } + }); - clipboard.on('success', function(e) { - changeTooltipMessage(e.trigger, 'Copied!'); - e.clearSelection(); - }); + clipboard.on('success', function (e) { + changeTooltipMessage(e.trigger, 'Copied!'); + e.clearSelection(); + }); - clipboard.on('error', function(e) { - changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); - }); + clipboard.on('error', function (e) { + changeTooltipMessage(e.trigger, 'Press Ctrl+C or Command+C to copy'); + }); - }); - } + }); + } /* Search marking --------------------------*/ var url = new URL(window.location.href); @@ -80,80 +80,80 @@ }); } - /* Search --------------------------*/ - /* Adapted from https://github.com/rstudio/bookdown/blob/2d692ba4b61f1e466c92e78fd712b0ab08c11d31/inst/resources/bs4_book/bs4_book.js#L25 */ + /* Search --------------------------*/ + /* Adapted from https://github.com/rstudio/bookdown/blob/2d692ba4b61f1e466c92e78fd712b0ab08c11d31/inst/resources/bs4_book/bs4_book.js#L25 */ // Initialise search index on focus - var fuse; - $("#search-input").focus(async function(e) { - if (fuse) { - return; - } - - $(e.target).addClass("loading"); - var response = await fetch($("#search-input").data("search-index")); - var data = await response.json(); + var fuse; + $("#search-input").focus(async function (e) { + if (fuse) { + return; + } + + $(e.target).addClass("loading"); + var response = await fetch($("#search-input").data("search-index")); + var data = await response.json(); + + var options = { + keys: ["what", "text", "code"], + ignoreLocation: true, + threshold: 0.1, + includeMatches: true, + includeScore: true, + }; + fuse = new Fuse(data, options); + + $(e.target).removeClass("loading"); + }); + // Use algolia autocomplete var options = { - keys: ["what", "text", "code"], - ignoreLocation: true, - threshold: 0.1, - includeMatches: true, - includeScore: true, + autoselect: true, + debug: true, + hint: false, + minLength: 2, }; - fuse = new Fuse(data, options); - - $(e.target).removeClass("loading"); - }); - - // Use algolia autocomplete - var options = { - autoselect: true, - debug: true, - hint: false, - minLength: 2, - }; - var q; -async function searchFuse(query, callback) { - await fuse; - - var items; - if (!fuse) { - items = []; - } else { - q = query; - var results = fuse.search(query, { limit: 20 }); - items = results - .filter((x) => x.score <= 0.75) - .map((x) => x.item); - if (items.length === 0) { - items = [{dir:"Sorry 😿",previous_headings:"",title:"No results found.",what:"No results found.",path:window.location.href}]; + var q; + async function searchFuse(query, callback) { + await fuse; + + var items; + if (!fuse) { + items = []; + } else { + q = query; + var results = fuse.search(query, { limit: 20 }); + items = results + .filter((x) => x.score <= 0.75) + .map((x) => x.item); + if (items.length === 0) { + items = [{ dir: "Sorry 😿", previous_headings: "", title: "No results found.", what: "No results found.", path: window.location.href }]; + } + } + callback(items); } - } - callback(items); -} - $("#search-input").autocomplete(options, [ - { - name: "content", - source: searchFuse, - templates: { - suggestion: (s) => { - if (s.title == s.what) { - return `${s.dir} >
${s.title}
`; - } else if (s.previous_headings == "") { - return `${s.dir} >
${s.title}
> ${s.what}`; - } else { - return `${s.dir} >
${s.title}
> ${s.previous_headings} > ${s.what}`; - } + $("#search-input").autocomplete(options, [ + { + name: "content", + source: searchFuse, + templates: { + suggestion: (s) => { + if (s.title == s.what) { + return `${s.dir} >
${s.title}
`; + } else if (s.previous_headings == "") { + return `${s.dir} >
${s.title}
> ${s.what}`; + } else { + return `${s.dir} >
${s.title}
> ${s.previous_headings} > ${s.what}`; + } + }, }, }, - }, - ]).on('autocomplete:selected', function(event, s) { - window.location.href = s.path + "?q=" + q + "#" + s.id; - }); + ]).on('autocomplete:selected', function (event, s) { + window.location.href = s.path + "?q=" + q + "#" + s.id; + }); }); })(window.jQuery || window.$) -document.addEventListener('keydown', function(event) { +document.addEventListener('keydown', function (event) { // Check if the pressed key is '/' if (event.key === '/') { event.preventDefault(); // Prevent any default action associated with the '/' key diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index a2c574f9..b0b08c8b 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,11 +1,11 @@ pandoc: 3.8.2.1 -pkgdown: 2.1.3 +pkgdown: 2.2.0 pkgdown_sha: ~ articles: analysis-package-layout: analysis-package-layout.html rdev: rdev.html style-guide: style-guide.html -last_built: 2025-10-29T22:45Z +last_built: 2025-11-24T02:18Z urls: reference: https://jabenninghoff.github.io/rdev/reference article: https://jabenninghoff.github.io/rdev/articles diff --git a/docs/reference/build_analysis_site.html b/docs/reference/build_analysis_site.html index b5899aac..e230502e 100644 --- a/docs/reference/build_analysis_site.html +++ b/docs/reference/build_analysis_site.html @@ -9,7 +9,7 @@ rdev - 1.15.2 + 1.15.3