From 5423be1902a946bb28ef8654e2c41d8a7350ba27 Mon Sep 17 00:00:00 2001 From: Teun van den Brand Date: Sat, 7 Sep 2024 16:13:56 +0200 Subject: [PATCH] update pkgdown index --- R/gguidance-package.R | 1 + _pkgdown.yml | 42 +++++++++++++++++++++++++++++++++++++ man/gguidance_extensions.Rd | 1 + 3 files changed, 44 insertions(+) diff --git a/R/gguidance-package.R b/R/gguidance-package.R index f94c6b1..ee35729 100644 --- a/R/gguidance-package.R +++ b/R/gguidance-package.R @@ -24,6 +24,7 @@ NULL #' variations on axes, legends and colourbars. #' #' @seealso The documentation over at [`ggproto`][ggplot2::ggproto()]. +#' @keywords internal NULL #' @name common_parameters diff --git a/_pkgdown.yml b/_pkgdown.yml index f6f9fa0..441e6b6 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -2,3 +2,45 @@ url: https://teunbrand.github.io/gguidance/ template: bootstrap: 5 +reference: +- title: Guides to go + desc: > + These guides are complete and ready to use in your plots. + contents: + - starts_with("guide_") + +- title: Primitives + desc: > + These are incomplete guides used in composition. + contents: + - guide-primitives + - starts_with("primitive_") + +- title: Gizmos + desc: > + These are specialty gimmicks tailored to displaying specific aesthetics. + contents: + - guide-gizmos + - starts_with("gizmo_") + +- title: Composition + desc: > + These are not guides, but ways to combine guides, primitives and gizmos + together to become a more complete guide. + contents: + - guide-composition + - starts_with("compose_") + +- title: Keys + desc: > + Fantastic labels and where to display them. + contents: + - starts_with("key_") + +- title: Other functions + desc: > + Miscellaneous functions not directly concerned with guides + contents: + - bracket_options + - cap_options + - theme_guide diff --git a/man/gguidance_extensions.Rd b/man/gguidance_extensions.Rd index 6f3c2a5..856b74e 100644 --- a/man/gguidance_extensions.Rd +++ b/man/gguidance_extensions.Rd @@ -43,3 +43,4 @@ variations on axes, legends and colourbars. The documentation over at \code{\link[ggplot2:ggproto]{ggproto}}. } \keyword{datasets} +\keyword{internal}