Improve pkgdown deployment

Why? Examples that require credentials throw an error message. What? Silence these examples with dontrun.
opendatasoft · Mar 16, 2022 · 3772e38 · 3772e38
1 parent feb675c
commit 3772e38
Show file tree

Hide file tree

Showing 8 changed files with 92 additions and 72 deletions.
diff --git a/R/get_ods_page.R b/R/get_ods_page.R
@@ -11,9 +11,10 @@
 #' 
 #' @export
 #' @examples
+#' \dontrun{
 #' page_slug <- "odsrmd-example" 
 #' page_elements <- get_ods_page(page_slug) 
-#' 
+#' }
 get_ods_page <- function(page_slug) {
   if (page_slug == "") {
     stop(

diff --git a/R/put_ods_page.R b/R/put_ods_page.R
@@ -12,6 +12,7 @@
 #' 
 #' @export
 #' @examples
+#' \dontrun{
 #' # Temporary directory for reproducible example
 #' dir_tmp <- tempfile(pattern = "proj-")
 #' dir.create(dir_tmp)
@@ -31,6 +32,7 @@
 #'                         tags = NULL, restricted = NULL)
 #' 
 #' put_ods_page(page_slug, json_to_send)
+#' }
 put_ods_page <- function(page_slug, json_to_send) {
   if (page_slug == "") {
     stop(

diff --git a/R/update_ods_page.R b/R/update_ods_page.R
@@ -13,6 +13,7 @@
 #' 
 #' @export
 #' @examples
+#' \dontrun{
 #' # Temporary directory for reproducible example
 #' dir_tmp <- tempfile(pattern = "proj-")
 #' dir.create(dir_tmp)
@@ -26,6 +27,7 @@
 #' update_ods_page(path, page_slug, add_extra_css = "no", chosen_languages = "all", title = NULL,
 #'   description = NULL, tags = NULL, restricted = NULL
 #' )
+#' }
 update_ods_page <- function(path, page_slug, add_extra_css = "no", chosen_languages = "all", title = NULL,
                             description = NULL, tags = NULL, restricted = NULL){
 

diff --git a/dev/flat_full.Rmd b/dev/flat_full.Rmd
@@ -414,9 +414,10 @@ get_ods_page <- function(page_slug) {
 ```
 
 ```{r example-get_ods_page, eval=FALSE}
-page_slug <- "odsrmd-example" 
-page_elements <- get_ods_page(page_slug) 
-
+#' \dontrun{
+#' page_slug <- "odsrmd-example" 
+#' page_elements <- get_ods_page(page_slug) 
+#' }
 ```
 
 ```{r tests-get_ods_page}
@@ -878,25 +879,27 @@ put_ods_page <- function(page_slug, json_to_send) {
 ```
 
 ```{r example-put_ods_page, eval=FALSE}
-# Temporary directory for reproducible example
-dir_tmp <- tempfile(pattern = "proj-")
-dir.create(dir_tmp)
-
-file.copy(from = system.file("examples/example_rmd.Rmd", package = "odsrmd"), to=dir_tmp)
-file.copy(from = system.file("examples/style.css", package = "odsrmd"), to=dir_tmp)
-# browseURL(dir_tmp)
-path <- paste0(dir_tmp, "/example_rmd.Rmd")
-page_slug <- "odsrmd-example"
-
-body_and_style <- get_body_and_style(path)
-
-page_elements <- get_ods_page(page_slug)
-
-json_to_send <- create_json(page_elements, body_and_style, chosen_languages = c("en", "fr"), 
-                        title = "English title", description = NULL,  
-                        tags = NULL, restricted = NULL)
-
-put_ods_page(page_slug, json_to_send)
+#' \dontrun{
+#' # Temporary directory for reproducible example
+#' dir_tmp <- tempfile(pattern = "proj-")
+#' dir.create(dir_tmp)
+#' 
+#' file.copy(from = system.file("examples/example_rmd.Rmd", package = "odsrmd"), to=dir_tmp)
+#' file.copy(from = system.file("examples/style.css", package = "odsrmd"), to=dir_tmp)
+#' # browseURL(dir_tmp)
+#' path <- paste0(dir_tmp, "/example_rmd.Rmd")
+#' page_slug <- "odsrmd-example"
+#' 
+#' body_and_style <- get_body_and_style(path)
+#' 
+#' page_elements <- get_ods_page(page_slug)
+#' 
+#' json_to_send <- create_json(page_elements, body_and_style, chosen_languages = c("en", "fr"), 
+#'                         title = "English title", description = NULL,  
+#'                         tags = NULL, restricted = NULL)
+#' 
+#' put_ods_page(page_slug, json_to_send)
+#' }
 ```
 
 ```{r tests-put_ods_page}
@@ -960,19 +963,21 @@ put_ods_page(page_slug, json_to_send)
 ```
 
 ```{r example-update_ods_page, eval=FALSE}
-# Temporary directory for reproducible example
-dir_tmp <- tempfile(pattern = "proj-")
-dir.create(dir_tmp)
-
-file.copy(from = system.file("examples/example_rmd.Rmd", package = "odsrmd"), to = dir_tmp)
-file.copy(from = system.file("examples/style.css", package = "odsrmd"), to=dir_tmp)
-# browseURL(dir_tmp)
-path <- paste0(dir_tmp, "/example_rmd.Rmd")
-page_slug <- "odsrmd-example"
-
-update_ods_page(path, page_slug, add_extra_css = "no", chosen_languages = "all", title = NULL,
-  description = NULL, tags = NULL, restricted = NULL
-)
+#' \dontrun{
+#' # Temporary directory for reproducible example
+#' dir_tmp <- tempfile(pattern = "proj-")
+#' dir.create(dir_tmp)
+#' 
+#' file.copy(from = system.file("examples/example_rmd.Rmd", package = "odsrmd"), to = dir_tmp)
+#' file.copy(from = system.file("examples/style.css", package = "odsrmd"), to=dir_tmp)
+#' # browseURL(dir_tmp)
+#' path <- paste0(dir_tmp, "/example_rmd.Rmd")
+#' page_slug <- "odsrmd-example"
+#' 
+#' update_ods_page(path, page_slug, add_extra_css = "no", chosen_languages = "all", title = NULL,
+#'   description = NULL, tags = NULL, restricted = NULL
+#' )
+#' }
 ```
 
 ```{r tests-update_ods_page}

diff --git a/man/get_ods_page.Rd b/man/get_ods_page.Rd
diff --git a/man/put_ods_page.Rd b/man/put_ods_page.Rd
diff --git a/man/update_ods_page.Rd b/man/update_ods_page.Rd
diff --git a/vignettes/get-started.Rmd b/vignettes/get-started.Rmd
@@ -160,9 +160,10 @@ body_and_style <- get_body_and_style(path, add_extra_css = "no")
 
 
 ```{r example-get_ods_page, eval = FALSE}
-page_slug <- "odsrmd-example" 
-page_elements <- get_ods_page(page_slug) 
-
+#' \dontrun{
+#' page_slug <- "odsrmd-example" 
+#' page_elements <- get_ods_page(page_slug) 
+#' }
 ```
 
 
@@ -259,25 +260,27 @@ json_to_send <- create_json(page_elements, body_and_style,
 
 
 ```{r example-put_ods_page, eval = FALSE}
-# Temporary directory for reproducible example
-dir_tmp <- tempfile(pattern = "proj-")
-dir.create(dir_tmp)
-
-file.copy(from = system.file("examples/example_rmd.Rmd", package = "odsrmd"), to=dir_tmp)
-file.copy(from = system.file("examples/style.css", package = "odsrmd"), to=dir_tmp)
-# browseURL(dir_tmp)
-path <- paste0(dir_tmp, "/example_rmd.Rmd")
-page_slug <- "odsrmd-example"
-
-body_and_style <- get_body_and_style(path)
-
-page_elements <- get_ods_page(page_slug)
-
-json_to_send <- create_json(page_elements, body_and_style, chosen_languages = c("en", "fr"), 
-                        title = "English title", description = NULL,  
-                        tags = NULL, restricted = NULL)
-
-put_ods_page(page_slug, json_to_send)
+#' \dontrun{
+#' # Temporary directory for reproducible example
+#' dir_tmp <- tempfile(pattern = "proj-")
+#' dir.create(dir_tmp)
+#' 
+#' file.copy(from = system.file("examples/example_rmd.Rmd", package = "odsrmd"), to=dir_tmp)
+#' file.copy(from = system.file("examples/style.css", package = "odsrmd"), to=dir_tmp)
+#' # browseURL(dir_tmp)
+#' path <- paste0(dir_tmp, "/example_rmd.Rmd")
+#' page_slug <- "odsrmd-example"
+#' 
+#' body_and_style <- get_body_and_style(path)
+#' 
+#' page_elements <- get_ods_page(page_slug)
+#' 
+#' json_to_send <- create_json(page_elements, body_and_style, chosen_languages = c("en", "fr"), 
+#'                         title = "English title", description = NULL,  
+#'                         tags = NULL, restricted = NULL)
+#' 
+#' put_ods_page(page_slug, json_to_send)
+#' }
 ```
 
 
@@ -293,19 +296,21 @@ put_ods_page(page_slug, json_to_send)
 
 
 ```{r example-update_ods_page, eval = FALSE}
-# Temporary directory for reproducible example
-dir_tmp <- tempfile(pattern = "proj-")
-dir.create(dir_tmp)
-
-file.copy(from = system.file("examples/example_rmd.Rmd", package = "odsrmd"), to = dir_tmp)
-file.copy(from = system.file("examples/style.css", package = "odsrmd"), to=dir_tmp)
-# browseURL(dir_tmp)
-path <- paste0(dir_tmp, "/example_rmd.Rmd")
-page_slug <- "odsrmd-example"
-
-update_ods_page(path, page_slug, add_extra_css = "no", chosen_languages = "all", title = NULL,
-  description = NULL, tags = NULL, restricted = NULL
-)
+#' \dontrun{
+#' # Temporary directory for reproducible example
+#' dir_tmp <- tempfile(pattern = "proj-")
+#' dir.create(dir_tmp)
+#' 
+#' file.copy(from = system.file("examples/example_rmd.Rmd", package = "odsrmd"), to = dir_tmp)
+#' file.copy(from = system.file("examples/style.css", package = "odsrmd"), to=dir_tmp)
+#' # browseURL(dir_tmp)
+#' path <- paste0(dir_tmp, "/example_rmd.Rmd")
+#' page_slug <- "odsrmd-example"
+#' 
+#' update_ods_page(path, page_slug, add_extra_css = "no", chosen_languages = "all", title = NULL,
+#'   description = NULL, tags = NULL, restricted = NULL
+#' )
+#' }
 ```