Skip to content

Commit

Permalink
Advertise more has_concept() by using it! + add `@family site compo…
Browse files Browse the repository at this point in the history
…nents`
  • Loading branch information
olivroy committed Jun 4, 2024
1 parent d62bbec commit f3cf62b
Show file tree
Hide file tree
Showing 11 changed files with 45 additions and 1 deletion.
1 change: 1 addition & 0 deletions R/build-articles.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions R/build-home.R
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,7 @@
#' sidebar: FALSE
#' ```
#' @inheritParams build_articles
#' @family site components
#' @export
#' @order 1
build_home <- function(pkg = ".",
Expand Down
1 change: 1 addition & 0 deletions R/build-news.R
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
#' news:
#' cran_dates: false
#' ```
#' @family site components
#'
#' @seealso [Tidyverse style for News](https://style.tidyverse.org/news.html)
#'
Expand Down
1 change: 1 addition & 0 deletions R/build-reference.R
Original file line number Diff line number Diff line change
Expand Up @@ -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()].
Expand Down
1 change: 1 addition & 0 deletions R/build-tutorials.R
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 8 additions & 0 deletions man/build_articles.Rd

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

8 changes: 8 additions & 0 deletions man/build_home.Rd

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

7 changes: 7 additions & 0 deletions man/build_news.Rd

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

8 changes: 8 additions & 0 deletions man/build_reference.Rd

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

8 changes: 8 additions & 0 deletions man/build_tutorials.Rd

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

2 changes: 1 addition & 1 deletion vignettes/pkgdown.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit f3cf62b

Please sign in to comment.