Merge branch 'main' into quarto-regression-test

Author: jayhesselberth

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: pkgdown
 Title: Make Static HTML Documentation for a Package
-Version: 2.1.1.9000
+Version: 2.1.3.9000
 Authors@R: c(
     person("Hadley", "Wickham", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-4757-117X")),
@@ -70,9 +70,9 @@ Config/Needs/website: usethis, servr
 Config/potools/style: explicit
 Config/testthat/edition: 3
 Config/testthat/parallel: true
-Config/testthat/start-first: build-article, build-quarto-article, build-reference
+Config/testthat/start-first: build-article, build-quarto-article, build-reference, build
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2.9000
 SystemRequirements: pandoc
 Remotes: quarto-dev/quarto-r@libpaths
+RoxygenNote: 7.3.2

NEWS.md

@@ -1,16 +1,29 @@
 # pkgdown (development version)
 
-* Option `pkgdown.internet` was removed because CDN file caching now requires an internet connection.
-* Support for math rendering using katex and mathjax was improved and now includes necessary components using CDN (#2704).
-* Articles (i.e., Rmarkdown/Quarto documents in `vignettes/articles`, created by `usethis::use_article()` and available on pkgdown sites but not included in a built package) have improved test cases (thanks to @venpopov and @ethanbass).
+* `build_site()` gained a `quiet` argument, which is propagated to other functions
+  (e.g., `build_articles()`) and is useful for debugging build errors on GH actions.
+
+# pkgdown 2.1.3
+
+* Menu items can now set `class` and `id`.
+
+# pkgdown 2.1.2
+
+## New features
+
 * ROR IDs in `DESCRIPTION` are transformed into icons, similar to ORCID IDs. (#2850)
+* New `clean_site(force = TRUE)` for cleaning of `docs/` regardless of whether it was built by pkgdown (#2827).
+* The language of the site is set from the first `Language:` in the `DESCRIPTION` if it is available and no other language is specified (@jonthegeek, #2808).
+
+## Bug fixes and minor improvements
+
+* Option `pkgdown.internet` was removed because CDN file caching now requires an internet connection.
+* Math rendering using katex and mathjax was improved and now includes necessary components using CDN (#2704).
+* Articles have improved test cases (thanks to @venpopov and @ethanbass).
 * Sass variables from bslib are now used to set the navbar background color: `$navbar-bg` for the background color in light and dark mode, or `$navbar-light-bg` and `$navbar-dark-bg` for individually controlling light and dark mode background colors. `pkgdown-navbar-bg` and `$pkgdown-navbar-bg-dark` both still provide pkgdown-specific overrides (@gadenbuie, #2847).
 * Code repositories hosted on Codeberg are now supported in the `BugReports` and `URL` fields (@nfrerebeau, #2843).
-* Articles (i.e., Rmd/qmd files in `vignettes/articles`, created by `usethis::use_article()` and available on pkgdown sites but not included in a built package) have improved test cases (thanks to @venpopov and @ethanbass).
-* New `clean_site(force = TRUE)` for cleaning of `docs/` regardless of whether it was built by pkgdown (#2827).
 * Links to favicons in page headers were updated to reflect changes to https://realfavicongenerator.net/ (#2804). Favicons should be re-generated by manually removing the `pkgdown/favicon` directory and then running `pkgdown::build_favicons()`.
 * Reinstate Rd macro loading, which was accidentally disabled in v2.1.1 (#2782).
-* The language of the site is set from the first `Language:` in the `DESCRIPTION` if it is available and no other language is specified (@jonthegeek, #2808).
 
 # pkgdown 2.1.1
 

R/build.R

@@ -301,6 +301,8 @@
 #'   in the current process affects the build process.
 #' @param install If `TRUE`, will install the package in a temporary library
 #'   so it is available for vignettes.
+#' @param quiet If `FALSE`, generate build messages for build functions that
+#'   take `quiet` arguments.
 #' @export
 #' @examples
 #' \dontrun{
@@ -318,7 +320,8 @@ build_site <- function(
   preview = NA,
   devel = FALSE,
   new_process = !devel,
-  install = !devel
+  install = !devel,
+  quiet = TRUE
 ) {
   pkg <- as_pkgdown(pkg, override = override)
   check_bool(devel)
@@ -352,7 +355,8 @@ build_site <- function(
       lazy = lazy,
       override = override,
       preview = preview,
-      devel = devel
+      devel = devel,
+      quiet = quiet
     )
   } else {
     build_site_local(
@@ -363,7 +367,8 @@ build_site <- function(
       lazy = lazy,
       override = override,
       preview = preview,
-      devel = devel
+      devel = devel,
+      quiet = quiet
     )
   }
 }
@@ -376,7 +381,8 @@ build_site_external <- function(
   lazy = FALSE,
   override = list(),
   preview = NA,
-  devel = TRUE
+  devel = TRUE,
+  quiet = TRUE
 ) {
   pkg <- as_pkgdown(pkg, override = override)
   args <- list(
@@ -390,6 +396,7 @@ build_site_external <- function(
     preview = FALSE,
     new_process = FALSE,
     devel = devel,
+    quiet = quiet,
     cli_colors = cli::num_ansi_colors(),
     hyperlinks = cli::ansi_has_hyperlink_support()
   )
@@ -422,7 +429,8 @@ build_site_local <- function(
   lazy = FALSE,
   override = list(),
   preview = NA,
-  devel = TRUE
+  devel = TRUE,
+  quiet = TRUE
 ) {
   pkg <- section_init(pkg, override = override)
 
@@ -438,7 +446,7 @@ build_site_local <- function(
     init_site(pkg, override)
   }
 
-  build_home(pkg, override = override, preview = FALSE)
+  build_home(pkg, override = override, quiet = quiet, preview = FALSE)
   build_reference(
     pkg,
     lazy = lazy,
@@ -449,7 +457,13 @@ build_site_local <- function(
     preview = FALSE,
     devel = devel
   )
-  build_articles(pkg, lazy = lazy, override = override, preview = FALSE)
+  build_articles(
+    pkg,
+    lazy = lazy,
+    override = override,
+    quiet = quiet,
+    preview = FALSE
+  )
   build_tutorials(pkg, override = override, preview = FALSE)
   build_news(pkg, override = override, preview = FALSE)
   build_sitemap(pkg)

R/navbar-menu.R

@@ -15,8 +15,22 @@ menu_submenu <- function(text, menu, icon = NULL, label = NULL, id = NULL) {
     ))
   }
 }
-menu_link <- function(text, href, target = NULL) {
-  purrr::compact(list(text = text, href = href, target = target))
+menu_link <- function(
+  text,
+  href,
+  target = NULL,
+  class = NULL,
+  id = NULL,
+  title = NULL
+) {
+  purrr::compact(list(
+    text = text,
+    href = href,
+    target = target,
+    class = class,
+    id = id,
+    title = title
+  ))
 }
 menu_links <- function(text, href) {
   purrr::map2(text, href, menu_link)
@@ -151,11 +165,14 @@ navbar_html_menu <- function(
 }
 
 navbar_html_link <- function(x, menu_depth = 0) {
+  base_class <- if (menu_depth == 0) "nav-link" else "dropdown-item"
   html_tag(
     "a",
-    class = if (menu_depth == 0) "nav-link" else "dropdown-item",
+    class = paste0(c(base_class, x$class), collapse = " "),
+    id = x$id,
     href = x$href,
     target = x$target,
+    title = x$title,
     "aria-label" = x$`aria-label`,
     navbar_html_text(x)
   )

air.toml

@@ -0,0 +1,2 @@
+[format]
+skip = ["tribble"]

cran-comments.md

@@ -4,7 +4,4 @@
 
 ## revdepcheck results
 
-We checked 144 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
-
- * We saw 0 new problems
- * We failed to check 3 packages: clusttree, multinma, and scDiffCom
+This was a very minor addition, so I did not check revdeps.

man/build_site.Rd

@@ -1,15 +1,2 @@
 # Revdeps
 
-## Failed to check (2)
-
-|package  |version |error |warning |note |
-|:--------|:-------|:-----|:-------|:----|
-|bayesCT  |0.99.3  |1     |        |     |
-|multinma |0.7.1   |1     |        |     |
-
-## New problems (1)
-
-|package    |version |error |warning |note |
-|:----------|:-------|:-----|:-------|:----|
-|[preferably](problems.md#preferably)|0.4.1   |      |__+1__  |     |
-

revdep/README.md

@@ -1,20 +1,7 @@
 ## revdepcheck results
 
-We checked 144 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
+We checked 156 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
 
- * We saw 1 new problems
- * We failed to check 2 packages
+ * We saw 0 new problems
+ * We failed to check 0 packages
 
-Issues with CRAN packages are summarised below.
-
-### New problems
-(This reports the first line of each new failure)
-
-* preferably
-  checking whether package ‘preferably’ can be installed ... WARNING
-  I have submitted a patch at https://github.com/amirmasoudabdol/preferably/pull/19.
-
-### Failed to check
-
-* bayesCT  (NA)
-* multinma (NA)