Test math rendering in examples

Part of #2704
r-lib · Aug 8, 2024 · 3128b0e · 3128b0e
1 parent 502c3e2
commit 3128b0e
Show file tree

Hide file tree

Showing 15 changed files with 62 additions and 2 deletions.
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/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"