Skip to content

Commit

Permalink
docs: use rlang::is_interactive(), override for pkgdown website
Browse files Browse the repository at this point in the history
  • Loading branch information
maelle committed Nov 12, 2024
1 parent f6e6b8b commit 86e1c02
Show file tree
Hide file tree
Showing 15 changed files with 21 additions and 19 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 🚀
Expand Down
2 changes: 1 addition & 1 deletion R/client.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
#' @export
#'
#' @seealso `WFSClient` in package `ows4R`.
#' @examplesIf interactive()
#' @examplesIf rlang::is_interactive()
#' wfs <- emodnet_init_wfs_client(service = "bathymetry")
emodnet_init_wfs_client <- function(service,
service_version = NULL,
Expand Down
2 changes: 1 addition & 1 deletion R/emodnet_wfs.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#'
#' @return Tibble of available EMODnet Web Feature Services
#'
#' @examplesIf interactive()
#' @examplesIf rlang::is_interactive()
#' emodnet_wfs()
#' @export
emodnet_wfs <- memoise::memoise(.emodnet_wfs)
2 changes: 1 addition & 1 deletion R/info.R
Original file line number Diff line number Diff line change
Expand Up @@ -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 rlang::is_interactive()
#' emodnet_get_wfs_info(service = "bathymetry")
#' # Query a wfs object
#' wfs_bio <- emodnet_init_wfs_client("biology")
Expand Down
10 changes: 5 additions & 5 deletions R/layer_attributes.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#' @family attributes
#' @export
#'
#' @examplesIf interactive()
#' @examplesIf rlang::is_interactive()
#' layer_attributes_summarise(
#' service = "biology",
#' layer = "mediseh_zostera_m_pnt"
Expand Down Expand Up @@ -44,7 +44,7 @@ layer_attributes_summarise <- function(wfs = NULL,
#' @family attributes
#' @export
#'
#' @examplesIf interactive()
#' @examplesIf rlang::is_interactive()
#' layer_attribute_descriptions(
#' service = "biology",
#' layer = "mediseh_zostera_m_pnt"
Expand Down Expand Up @@ -76,7 +76,7 @@ layer_attribute_descriptions <- function(wfs = NULL,
#' @return character vector of layer attribute (variable) names.
#' @export
#'
#' @examplesIf interactive()
#' @examplesIf rlang::is_interactive()
#' layer_attributes_get_names(
#' service = "biology",
#' layer = "mediseh_zostera_m_pnt"
Expand Down Expand Up @@ -114,7 +114,7 @@ layer_attributes_get_names <- function(wfs = NULL,
#' @family attributes
#' @export
#'
#' @examplesIf interactive()
#' @examplesIf rlang::is_interactive()
#' wfs <- emodnet_init_wfs_client(service = "biology")
#' layer_attributes_get_names(wfs, layer = "mediseh_zostera_m_pnt")
#' layer_attribute_inspect(
Expand Down Expand Up @@ -183,7 +183,7 @@ layer_attribute_inspect <- function(wfs = NULL,
#' @family attributes
#' @export
#'
#' @examplesIf interactive()
#' @examplesIf rlang::is_interactive()
#' layer_attributes_tbl(service = "biology", layer = "mediseh_zostera_m_pnt")
layer_attributes_tbl <- function(wfs = NULL,
service = NULL,
Expand Down
2 changes: 1 addition & 1 deletion R/layers.R
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
#' an `sf` out of a single layer request instead of a list of length 1.
#' @export
#'
#' @examplesIf interactive()
#' @examplesIf rlang::is_interactive()
#' # Layers as character vector
#' emodnet_get_layers(
#' service = "biology",
Expand Down
2 changes: 1 addition & 1 deletion man/emodnet_get_layers.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/emodnet_get_wfs_info.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/emodnet_init_wfs_client.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/emodnet_wfs.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/layer_attribute_descriptions.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/layer_attribute_inspect.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/layer_attributes_get_names.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/layer_attributes_summarise.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/layer_attributes_tbl.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 86e1c02

Please sign in to comment.