Merge branch 'main' into quarto-articles

r-lib · Dec 9, 2024 · 3bfa7aa · 3bfa7aa
2 parents f880086 + dfa28be
commit 3bfa7aa
Show file tree

Hide file tree

Showing 18 changed files with 70 additions and 6 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,7 @@
 # pkgdown (development version)
 
 * Articles (i.e., vignettes in `vignettes/articles`, created by `usethis::use_article()` and available on pkgdown sites but not included in a built package) have improved test cases.
+* 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()`.
 * 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).
 

diff --git a/R/clean.R b/R/clean.R
@@ -3,10 +3,11 @@
 #' Delete all files in `docs/` (except for `CNAME`).
 #'
 #' @param quiet If `TRUE`, suppresses a message.
+#' @param force If `TRUE`, delete contents of `docs` even if it is not a pkgdown site.
 #' @inheritParams build_site
 #' @rdname clean
 #' @export
-clean_site <- function(pkg = ".", quiet = FALSE) {
+clean_site <- function(pkg = ".", quiet = FALSE, force = FALSE) {
 
   pkg <- as_pkgdown(pkg)
 
@@ -17,7 +18,7 @@ clean_site <- function(pkg = ".", quiet = FALSE) {
   if (!dir_exists(pkg$dst_path)) return(invisible())
 
   top_level <- dest_files(pkg)
-  if (length(top_level) > 0) {
+  if (length(top_level) > 0 && !force) {
     check_dest_is_pkgdown(pkg)
   }
 
@@ -60,7 +61,7 @@ check_dest_is_pkgdown <- function(pkg) {
   cli::cli_abort(c(
     "{.file {pkg$dst_path}} is non-empty and not built by pkgdown",
     "!" = "Make sure it contains no important information \\
-            and use {.run pkgdown::clean_site()} to delete its contents."
+            and use {.run pkgdown::clean_site(force = TRUE)} to delete its contents."
     )
   )
 }

diff --git a/R/test.R b/R/test.R
@@ -129,7 +129,7 @@ NULL
 #'   x <- 4
 #' }
 #' x # should be 1
-#' 
+#'
 #' # \dontshow{} -------------------------------------------------------
 #' # never shown, always run
 #'
@@ -145,7 +145,7 @@ NULL
 #' # If FALSE, wrapped in if; if TRUE, not seen
 #'
 #' x <- 1
-#' 
+#'
 #' @examplesIf FALSE
 #' x <- 2
 #' @examplesIf TRUE
@@ -275,3 +275,17 @@ NULL
 #' @keywords internal
 #' @family tests
 NULL
+
+#' Test case: math rendering in examples
+#'
+#' @param x \eqn{f(x) > 0}: inline equation
+#'
+#' @details
+#' Display equation:
+#'
+#' \deqn{y = \alpha + \beta X + \varepsilon}
+#'
+#' @name test-math-examples
+#' @keywords internal
+#' @family tests
+NULL
diff --git a/man/clean.Rd b/man/clean.Rd
diff --git a/man/index.Rd b/man/index.Rd
diff --git a/man/test-crayon.Rd b/man/test-crayon.Rd
diff --git a/man/test-dont.Rd b/man/test-dont.Rd
diff --git a/man/test-figures.Rd b/man/test-figures.Rd
diff --git a/man/test-links.Rd b/man/test-links.Rd
diff --git a/man/test-lists.Rd b/man/test-lists.Rd
diff --git a/man/test-long-lines.Rd b/man/test-long-lines.Rd
diff --git a/man/test-math-examples.Rd b/man/test-math-examples.Rd
diff --git a/man/test-output-styles.Rd b/man/test-output-styles.Rd
diff --git a/man/test-params.Rd b/man/test-params.Rd
diff --git a/man/test-sexpr-title.Rd b/man/test-sexpr-title.Rd
diff --git a/man/test-tables.Rd b/man/test-tables.Rd
diff --git a/man/test-verbatim.Rd b/man/test-verbatim.Rd
diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml
@@ -17,6 +17,7 @@ authors:
 
 template:
   bootstrap: 5
+  math-rendering: mathjax
   light-switch: true
   bslib:
     primary: "#0054AD"