diff --git a/.Rbuildignore b/.Rbuildignore index b7a2a9f..611fd43 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -6,3 +6,6 @@ ^codecov\.yml$ ^\.github$ ^CODE_OF_CONDUCT\.md$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.gitignore b/.gitignore index 565f2b6..9168bf8 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ .Rdata .httr-oauth .DS_Store +docs diff --git a/DESCRIPTION b/DESCRIPTION index a907bc9..c84192f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -35,5 +35,6 @@ Imports: Remotes: dickoa/cgalh, thomasp85/euclid -URL: https://github.com/thomasp85/boundaries +URL: https://github.com/thomasp85/boundaries, + https://thomasp85.github.io/boundaries/ BugReports: https://github.com/thomasp85/boundaries/issues diff --git a/R/skeleton_limit.R b/R/skeleton_limit.R index 5a755a6..9546eaa 100644 --- a/R/skeleton_limit.R +++ b/R/skeleton_limit.R @@ -23,7 +23,7 @@ #' euclid_plot(vert(skeleton_limit_location(poly))) #' #' # But certain geometries will result in segments rather than lines -#' poly <- polygon( +#' poly <- polyclid::polygon( #' c(1, 1, 2, 2, -2, -2, -1, -1), #' c(-2, 0, 0, 2, 2, 0, 0, -2) #' ) diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..74d3949 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,68 @@ +destination: docs +url: https://boundaries.r-euclid.com + +authors: + Thomas Lin Pedersen: + href: https://data-imaginist.com + +home: + title: > + boundaries: Tools for working with polyclid polygon boundaries + description: > + boundaries is a utility package for the euclid ecosystem collecting tools + for working with and modifying the boundaries of polygons, e.g. performing + simplification while retaining approximate features, offsetting and + insetting, etc. + +template: + bootstrap: 5 + theme: a11y-light + bslib: + bg: "#F7FAF4" + fg: "#0B0B0B" + primary: "#23507F" + base_font: {google: "Gelasio"} + heading_font: {google: "Montserrat"} + code_font: {google: "Fira Code"} + opengraph: + image: + src: man/figures/card.png + alt: "boundaries: Tools for manipulating polyclid polygons" + twitter: + creator: "@thomasp85" + site: "@rstudio" + card: summary_large_image + +navbar: + bg: primary + type: dark + structure: + left: + - intro + - reference + - articles + - tutorials + - news + right: + - euclid + - github + components: + reference: + text: Reference + href: reference/index.html + euclid: + text: Euclid ecosystem + menu: + - text: Foundation + - text: Euclid + href: https://r-euclid.com + - text: Polyclid + href: https://polyclid.r-euclid.com + - text: ------- + - text: Utilities + - text: Orion + href: https://orion.r-euclid.com + github: + icon: fab fa-github fa-lg + href: https://github.com/thomasp85/boundaries/ + aria-label: github diff --git a/man/boundaries-package.Rd b/man/boundaries-package.Rd index 2780321..49cfb4f 100644 --- a/man/boundaries-package.Rd +++ b/man/boundaries-package.Rd @@ -14,6 +14,7 @@ A range of algorithms exists primarily to modify the boundary of polygons in dif Useful links: \itemize{ \item \url{https://github.com/thomasp85/boundaries} + \item \url{https://thomasp85.github.io/boundaries/} \item Report bugs at \url{https://github.com/thomasp85/boundaries/issues} } diff --git a/man/skeleton_limit.Rd b/man/skeleton_limit.Rd index 8873ed0..2fbe6ac 100644 --- a/man/skeleton_limit.Rd +++ b/man/skeleton_limit.Rd @@ -30,7 +30,7 @@ plot(poly) euclid_plot(vert(skeleton_limit_location(poly))) # But certain geometries will result in segments rather than lines -poly <- polygon( +poly <- polyclid::polygon( c(1, 1, 2, 2, -2, -2, -1, -1), c(-2, 0, 0, 2, 2, 0, 0, -2) ) diff --git a/pkgdown/favicon/apple-touch-icon-120x120.png b/pkgdown/favicon/apple-touch-icon-120x120.png new file mode 100644 index 0000000..6df9cd5 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-120x120.png differ diff --git a/pkgdown/favicon/apple-touch-icon-152x152.png b/pkgdown/favicon/apple-touch-icon-152x152.png new file mode 100644 index 0000000..071ceb5 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-152x152.png differ diff --git a/pkgdown/favicon/apple-touch-icon-180x180.png b/pkgdown/favicon/apple-touch-icon-180x180.png new file mode 100644 index 0000000..f873040 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-180x180.png differ diff --git a/pkgdown/favicon/apple-touch-icon-60x60.png b/pkgdown/favicon/apple-touch-icon-60x60.png new file mode 100644 index 0000000..9f96146 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-60x60.png differ diff --git a/pkgdown/favicon/apple-touch-icon-76x76.png b/pkgdown/favicon/apple-touch-icon-76x76.png new file mode 100644 index 0000000..3d8b353 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-76x76.png differ diff --git a/pkgdown/favicon/apple-touch-icon.png b/pkgdown/favicon/apple-touch-icon.png new file mode 100644 index 0000000..bd83883 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon.png differ diff --git a/pkgdown/favicon/favicon-16x16.png b/pkgdown/favicon/favicon-16x16.png new file mode 100644 index 0000000..e872252 Binary files /dev/null and b/pkgdown/favicon/favicon-16x16.png differ diff --git a/pkgdown/favicon/favicon-32x32.png b/pkgdown/favicon/favicon-32x32.png new file mode 100644 index 0000000..0f826d9 Binary files /dev/null and b/pkgdown/favicon/favicon-32x32.png differ diff --git a/pkgdown/favicon/favicon.ico b/pkgdown/favicon/favicon.ico new file mode 100644 index 0000000..f5fe3c9 Binary files /dev/null and b/pkgdown/favicon/favicon.ico differ