From f3cf62bbb37351880c3caacc7658b1cf9ae13218 Mon Sep 17 00:00:00 2001 From: olivroy Date: Tue, 4 Jun 2024 12:40:10 -0400 Subject: [PATCH] Advertise more `has_concept()` by using it! + add `@family site components` --- R/build-articles.R | 1 + R/build-home.R | 1 + R/build-news.R | 1 + R/build-reference.R | 1 + R/build-tutorials.R | 1 + man/build_articles.Rd | 8 ++++++++ man/build_home.Rd | 8 ++++++++ man/build_news.Rd | 7 +++++++ man/build_reference.Rd | 8 ++++++++ man/build_tutorials.Rd | 8 ++++++++ vignettes/pkgdown.Rmd | 2 +- 11 files changed, 45 insertions(+), 1 deletion(-) diff --git a/R/build-articles.R b/R/build-articles.R index 5fdb09757..68bc53571 100644 --- a/R/build-articles.R +++ b/R/build-articles.R @@ -181,6 +181,7 @@ #' [build_site()] details. #' #' @inheritSection build_reference Figures +#' @family site components #' #' @inheritParams as_pkgdown #' @param quiet Set to `FALSE` to display output of knitr and diff --git a/R/build-home.R b/R/build-home.R index 245496e1d..142378b33 100644 --- a/R/build-home.R +++ b/R/build-home.R @@ -283,6 +283,7 @@ #' sidebar: FALSE #' ``` #' @inheritParams build_articles +#' @family site components #' @export #' @order 1 build_home <- function(pkg = ".", diff --git a/R/build-news.R b/R/build-news.R index 14b7e4cae..c61c9753e 100644 --- a/R/build-news.R +++ b/R/build-news.R @@ -66,6 +66,7 @@ #' news: #' cran_dates: false #' ``` +#' @family site components #' #' @seealso [Tidyverse style for News](https://style.tidyverse.org/news.html) #' diff --git a/R/build-reference.R b/R/build-reference.R index 87c425151..e7529d5ed 100644 --- a/R/build-reference.R +++ b/R/build-reference.R @@ -136,6 +136,7 @@ #' as HTML widgets. #' #' @inheritParams build_articles +#' @family site components #' @param lazy If `TRUE`, only rebuild pages where the `.Rd` #' is more recent than the `.html`. This makes it much easier to #' rapidly prototype. It is set to `FALSE` by [build_site()]. diff --git a/R/build-tutorials.R b/R/build-tutorials.R index 69ed969d9..1060a3e87 100644 --- a/R/build-tutorials.R +++ b/R/build-tutorials.R @@ -26,6 +26,7 @@ #' url: https://jjallaire.shinyapps.io/learnr-tutorial-01-data-basics/ #' ``` #' @inheritParams build_articles +#' @family site components #' @export build_tutorials <- function(pkg = ".", override = list(), preview = NA) { pkg <- section_init(pkg, depth = 1L, override = override) diff --git a/man/build_articles.Rd b/man/build_articles.Rd index ef2b229f9..974cfe245 100644 --- a/man/build_articles.Rd +++ b/man/build_articles.Rd @@ -258,3 +258,11 @@ that will be available to custom graphics output devices such as HTML widgets. } +\seealso{ +Other site components: +\code{\link{build_home}()}, +\code{\link{build_news}()}, +\code{\link{build_reference}()}, +\code{\link{build_tutorials}()} +} +\concept{site components} diff --git a/man/build_home.Rd b/man/build_home.Rd index ebf5c6c59..224f4b5c6 100644 --- a/man/build_home.Rd +++ b/man/build_home.Rd @@ -292,3 +292,11 @@ Or completely remove it: }\if{html}{\out{}} } +\seealso{ +Other site components: +\code{\link{build_articles}()}, +\code{\link{build_news}()}, +\code{\link{build_reference}()}, +\code{\link{build_tutorials}()} +} +\concept{site components} diff --git a/man/build_news.Rd b/man/build_news.Rd index 4da4a3196..73f2d24f7 100644 --- a/man/build_news.Rd +++ b/man/build_news.Rd @@ -81,4 +81,11 @@ Suppress the default addition of CRAN release dates with: \seealso{ \href{https://style.tidyverse.org/news.html}{Tidyverse style for News} + +Other site components: +\code{\link{build_articles}()}, +\code{\link{build_home}()}, +\code{\link{build_reference}()}, +\code{\link{build_tutorials}()} } +\concept{site components} diff --git a/man/build_reference.Rd b/man/build_reference.Rd index 064a413fb..9067052cf 100644 --- a/man/build_reference.Rd +++ b/man/build_reference.Rd @@ -189,3 +189,11 @@ that will be available to custom graphics output devices such as HTML widgets. } +\seealso{ +Other site components: +\code{\link{build_articles}()}, +\code{\link{build_home}()}, +\code{\link{build_news}()}, +\code{\link{build_tutorials}()} +} +\concept{site components} diff --git a/man/build_tutorials.Rd b/man/build_tutorials.Rd index 1d7abe923..cebe6612f 100644 --- a/man/build_tutorials.Rd +++ b/man/build_tutorials.Rd @@ -43,3 +43,11 @@ section. This should be a list where each element specifies: }\if{html}{\out{}} } +\seealso{ +Other site components: +\code{\link{build_articles}()}, +\code{\link{build_home}()}, +\code{\link{build_news}()}, +\code{\link{build_reference}()} +} +\concept{site components} diff --git a/vignettes/pkgdown.Rmd b/vignettes/pkgdown.Rmd index f14db7d25..ea2291b7e 100644 --- a/vignettes/pkgdown.Rmd +++ b/vignettes/pkgdown.Rmd @@ -105,7 +105,7 @@ reference: Note the use of `starts_with()` to select all functions with a common prefix. You can also use `ends_with()` and `matches()`. -See complete details in `?build_reference`. +See complete details in `?build_reference`, including other topic matching helper functions. While iterating on the reference index you might want to run `pkgdown::build_reference_index()`. It just re-builds the index page, making it faster to quickly change `_pkgdown.yml` and see how it affects your site.