rebuild online manual

.devel/roxygen2-patch.R

@@ -1,57 +1,66 @@
-# Copyleft 2021-2022, Marek Gagolewski <https://www.gagolewski.com>
-# Adding author and other metadata to every Rd file
+# Copyleft (C) 2021-2024, Marek Gagolewski <https://www.gagolewski.com>
+# Adding author and other metadata to every Rd file;
+# There is one and only one official manual. Ad- and tracker-free.
+# Enjoy the free internet.
 
 library("roxygen2")
 
 postprocess_contents <- function(contents)
 {
     stopifnot(is.character(contents), length(contents)==1, !is.na(contents))
 
+    author <- "\\href{https://www.gagolewski.com/}{Marek Gagolewski}\n"
+
+    seealso <- stringi::stri_paste(
+        "The official online manual of \\pkg{stringx} at ",
+        "\\url{https://stringx.gagolewski.com/}\n",
+        "\n"
+    )
+
+
+
+
+
+
     if (!stringi::stri_detect_regex(
-        contents, "% Please edit documentation in R/.*\\\\name", dotall=TRUE)
+        contents, "% Please edit documentation in R/.*\\\\name", dotall=TRUE)  # fixed comment generated by roxugen2
     ) return(contents)
 
     if (!stringi::stri_detect_fixed(contents, "\\author")) {
         contents <- stringi::stri_paste(contents,
             "\\author{\n",
-            "\\href{https://www.gagolewski.com/}{Marek Gagolewski}\n",
+            author,
             "}\n")
     }
 
-    # There is one and only one official manual. Ad- and tracker-free.
-    # Enjoy the free internet.
-
     if (!stringi::stri_detect_fixed(contents, "\\seealso{\n")) {
-        contents <- stringi::stri_paste(contents,
-            "\\seealso{\n",
-            "The official online manual of \\pkg{stringx} at ",
-            "\\url{https://stringx.gagolewski.com/}\n",
-            "}\n")
+        contents <- stringi::stri_paste(
+            contents,
+            stringi::stri_paste("\\seealso{\n", seealso, "}\n")
+        )
     }
     else {
-        contents <- stringi::stri_replace_first_fixed(contents, "\\seealso{\n",
-            stringi::stri_paste(
-                "\\seealso{\n",
-                "The official online manual of \\pkg{stringx} at ",
-                "\\url{https://stringx.gagolewski.com/}\n",
-                "\n"
-            ))
+        contents <- stringi::stri_replace_first_fixed(
+            contents,
+            "\\seealso{\n",
+            stringi::stri_paste("\\seealso{\n", seealso)
+        )
     }
 
     contents
 }
 
 # ########################################################################### #
 
-# taken from roxygen2 7.2.1 by Hadley Wickham et al.
-write_if_different <- function (path, contents, href = NULL, check = TRUE)
+# taken from roxygen2 7.3.2 by Hadley Wickham et al.
+write_if_different <- function (path, contents, command=NULL, check=TRUE)
 {
     if (!file.exists(dirname(path))) {
         dir.create(dirname(path), showWarnings = FALSE)
     }
     name <- basename(path)
     if (check && !made_by_roxygen(path)) {
-        cli::cli_warn(c("Skipping {.path {name}}", x = "It already exists and was not generated by roxygen2."))
+        cli::cli_inform(c(x = "Skipping {.path {name}}", i = "It already exists and was not generated by roxygen2."))
         return(FALSE)
     }
     line_ending <- detect_line_ending(path)
@@ -66,12 +75,14 @@ write_if_different <- function (path, contents, href = NULL, check = TRUE)
 
 
     if (!str_detect(name, "^[a-zA-Z][a-zA-Z0-9_.-]*$")) {
-        cli::cli_warn(c("Skipping {.path {name}}", x = "Invalid file name"))
+        cli::cli_inform(c(x = "Skipping {.path {name}}", i = "Invalid file name"))
         FALSE
     }
     else {
-        if (!is.null(href)) {
-            name <- cli::style_hyperlink(name, href)
+        if (!is.null(command)) {
+            scheme <- "x-r-run"
+            url <- paste0(scheme, ":", command)
+            name <- cli::style_hyperlink(name, url)
         }
         cli::cli_inform("Writing {.path {name}}")
         writeBin(charToRaw(contents), path)

.devel/sphinx/_build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: a016edc6993837609ca08b30be4c8592
+config: d603e001b5ab45784ec34fbc9f471480
 tags: 645f666f9bcd5a90fca523b33c5a78b7

.devel/sphinx/_build/html/_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

.devel/sphinx/_build/html/_static/doctools.js

@@ -4,7 +4,7 @@
  *
  * Base JavaScript utilities for all Sphinx HTML documentation.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

.devel/sphinx/_build/html/_static/language_data.js

@@ -5,15 +5,15 @@
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
 
 var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
 
 
-/* Non-minified version is copied as a separate JS file, is available */
+/* Non-minified version is copied as a separate JS file, if available */
 
 /**
  * Porter Stemmer

.devel/sphinx/_build/html/_static/pygments.css

@@ -97,17 +97,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /*
 body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */
 body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */
 body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
-body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */
+body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */
 body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
 body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
-body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */
+body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */
 body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
 body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */
 body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */
 body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */
 body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
 body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
-body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */
+body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */
 body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */
 body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */
 body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */
@@ -183,17 +183,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol
 body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */
 body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */
 body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
-body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */
+body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */
 body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
 body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
-body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */
+body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */
 body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
 body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */
 body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */
 body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */
 body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
 body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
-body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */
+body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */
 body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */
 body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */
 body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */