docs: better example escaping, escaped for pkgdown

EMODnet · Nov 12, 2024 · 434d030 · 434d030
1 parent f6e6b8b
commit 434d030
Show file tree

Hide file tree

Showing 15 changed files with 21 additions and 19 deletions.
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -35,7 +35,9 @@ jobs:
           needs: website
 
       - name: Build site
-        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE, run_dont_run = TRUE)
+        run: |
+          options(rlang_interactive = TRUE)
+          pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE, run_dont_run = TRUE)
         shell: Rscript {0}
 
       - name: Deploy to GitHub pages 🚀

diff --git a/R/client.R b/R/client.R
@@ -15,7 +15,7 @@
 #' @export
 #'
 #' @seealso `WFSClient` in package `ows4R`.
-#' @examplesIf interactive()
+#' @examplesIf identical(Sys.getenv("IN_PKGDOWN"), "true") || interactive()
 #' wfs <- emodnet_init_wfs_client(service = "bathymetry")
 emodnet_init_wfs_client <- function(service,
                                     service_version = NULL,

diff --git a/R/emodnet_wfs.R b/R/emodnet_wfs.R
@@ -10,7 +10,7 @@
 #'
 #' @return Tibble of available EMODnet Web Feature Services
 #'
-#' @examplesIf interactive()
+#' @examplesIf identical(Sys.getenv("IN_PKGDOWN"), "true") || interactive()
 #' emodnet_wfs()
 #' @export
 emodnet_wfs <- memoise::memoise(.emodnet_wfs)
diff --git a/R/info.R b/R/info.R
@@ -91,7 +91,7 @@ emodnet_get_layer_info <- memoise::memoise(.emodnet_get_layer_info)
 #' @export
 #' @describeIn emodnet_get_wfs_info Get info on all layers from
 #' an EMODnet WFS service.
-#' @examplesIf interactive()
+#' @examplesIf identical(Sys.getenv("IN_PKGDOWN"), "true") || interactive()
 #' emodnet_get_wfs_info(service = "bathymetry")
 #' # Query a wfs object
 #' wfs_bio <- emodnet_init_wfs_client("biology")

diff --git a/R/layer_attributes.R b/R/layer_attributes.R
@@ -10,7 +10,7 @@
 #' @family attributes
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examplesIf identical(Sys.getenv("IN_PKGDOWN"), "true") || interactive()
 #' layer_attributes_summarise(
 #'   service = "biology",
 #'   layer = "mediseh_zostera_m_pnt"
@@ -44,7 +44,7 @@ layer_attributes_summarise <- function(wfs = NULL,
 #' @family attributes
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examplesIf identical(Sys.getenv("IN_PKGDOWN"), "true") || interactive()
 #' layer_attribute_descriptions(
 #'   service = "biology",
 #'   layer = "mediseh_zostera_m_pnt"
@@ -76,7 +76,7 @@ layer_attribute_descriptions <- function(wfs = NULL,
 #' @return character vector of layer attribute (variable) names.
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examplesIf identical(Sys.getenv("IN_PKGDOWN"), "true") || interactive()
 #' layer_attributes_get_names(
 #'   service = "biology",
 #'   layer = "mediseh_zostera_m_pnt"
@@ -114,7 +114,7 @@ layer_attributes_get_names <- function(wfs = NULL,
 #' @family attributes
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examplesIf identical(Sys.getenv("IN_PKGDOWN"), "true") || interactive()
 #' wfs <- emodnet_init_wfs_client(service = "biology")
 #' layer_attributes_get_names(wfs, layer = "mediseh_zostera_m_pnt")
 #' layer_attribute_inspect(
@@ -183,7 +183,7 @@ layer_attribute_inspect <- function(wfs = NULL,
 #' @family attributes
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examplesIf identical(Sys.getenv("IN_PKGDOWN"), "true") || interactive()
 #' layer_attributes_tbl(service = "biology", layer = "mediseh_zostera_m_pnt")
 layer_attributes_tbl <- function(wfs = NULL,
                                  service = NULL,

diff --git a/R/layers.R b/R/layers.R
@@ -41,7 +41,7 @@
 #' an `sf` out of a single layer request instead of a list of length 1.
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examplesIf identical(Sys.getenv("IN_PKGDOWN"), "true") || interactive()
 #' # Layers as character vector
 #' emodnet_get_layers(
 #'   service = "biology",

diff --git a/man/emodnet_get_layers.Rd b/man/emodnet_get_layers.Rd
diff --git a/man/emodnet_get_wfs_info.Rd b/man/emodnet_get_wfs_info.Rd
diff --git a/man/emodnet_init_wfs_client.Rd b/man/emodnet_init_wfs_client.Rd
diff --git a/man/emodnet_wfs.Rd b/man/emodnet_wfs.Rd
diff --git a/man/layer_attribute_descriptions.Rd b/man/layer_attribute_descriptions.Rd
diff --git a/man/layer_attribute_inspect.Rd b/man/layer_attribute_inspect.Rd
diff --git a/man/layer_attributes_get_names.Rd b/man/layer_attributes_get_names.Rd
diff --git a/man/layer_attributes_summarise.Rd b/man/layer_attributes_summarise.Rd
diff --git a/man/layer_attributes_tbl.Rd b/man/layer_attributes_tbl.Rd