Add pkgdown github action

hafen · Nov 29, 2023 · ff80d12 · ff80d12
1 parent 35d0197
commit ff80d12
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 24 deletions.
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,48 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ geofacet.sublime*
 geofacet.Rproj
 bug_reports
 .DS_Store
+docs
diff --git a/R/grid_docs.R b/R/grid_docs.R
@@ -386,7 +386,7 @@ NULL
 
 #' @name br_states_grid2
 #' @description
-#' * **br_states_grid2:** Grid for the 27 states of Brazil. Image reference [here](https://www.brazil-help.com/mapa_do_brasil.gif). Thanks to [hafen](https://github.com/hafen).
+#' * **br_states_grid2:** Grid for the 27 states of Brazil. Image reference [here](https://brazil-help.com/mapa_do_brasil.gif). Thanks to [hafen](https://github.com/hafen).
 #' @usage br_states_grid2
 #' @rdname grids
 #' @md
@@ -650,7 +650,7 @@ NULL
 
 #' @name us_mo_counties_grid1
 #' @description
-#' * **us_mo_counties_grid1:** Grids for Counties of Missouri, United States Image reference [here](https://camo.githubusercontent.com/d58ebdce931d0d42085d3b4d76f9e809bd147f84/68747470733a2f2f6f736564612e6d6973736f7572692e6564752f636f756e7479706167652f4d4f5f636f756e746965732e706e67). Thanks to [Yanqi-Xu](https://github.com/Yanqi-Xu).
+#' * **us_mo_counties_grid1:** Grids for Counties of Missouri, United States Image reference [here](https://private-user-images.githubusercontent.com/1275592/286454845-404f638c-76fe-4ef7-8756-e536ba3b5bfe.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTEiLCJleHAiOjE3MDEyMjQ5MzYsIm5iZiI6MTcwMTIyNDYzNiwicGF0aCI6Ii8xMjc1NTkyLzI4NjQ1NDg0NS00MDRmNjM4Yy03NmZlLTRlZjctODc1Ni1lNTM2YmEzYjViZmUucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQUlXTkpZQVg0Q1NWRUg1M0ElMkYyMDIzMTEyOSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyMzExMjlUMDIyMzU2WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9OGFhZmNmMTljMDMzZjYyZjc4OTRjMjI2NWY3NTUyMjNlMjViZjc5NGRiMjEwZWY4YzllYjhiYzNjNGE4YzZjNCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.dHa3geXvsIVsHuXvMhqT3I6seiiCOqTFIv3AeSF96Dw). Thanks to [Yanqi-Xu](https://github.com/Yanqi-Xu).
 #' @usage us_mo_counties_grid1
 #' @rdname grids
 #' @md
@@ -698,7 +698,7 @@ NULL
 
 #' @name ca_quebec_electoral_districts_grid1
 #' @description
-#' * **ca_quebec_electoral_districts_grid1:** Grid of Electoral Districts of Québec, Canada Image reference [here](https://camo.githubusercontent.com/d1f75185f1a675f1a358297ad0dbdae1b0d7b131/68747470733a2f2f7777772e656c656374696f6e737175656265632e71632e63612f3730616e732f6173736574732f696d672f323031312d342e6a7067). Thanks to [jhroy](https://github.com/jhroy).
+#' * **ca_quebec_electoral_districts_grid1:** Grid of Electoral Districts of Québec, Canada Image reference [here](https://private-user-images.githubusercontent.com/1275592/286448312-3de49f2f-cc0b-4509-b67a-84329245e4ab.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTEiLCJleHAiOjE3MDEyMjI1NTksIm5iZiI6MTcwMTIyMjI1OSwicGF0aCI6Ii8xMjc1NTkyLzI4NjQ0ODMxMi0zZGU0OWYyZi1jYzBiLTQ1MDktYjY3YS04NDMyOTI0NWU0YWIucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQUlXTkpZQVg0Q1NWRUg1M0ElMkYyMDIzMTEyOSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyMzExMjlUMDE0NDE5WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YjFjMjg3MTUzYTBkYmFkYWY1ODM5Nzg5YTg0MjIyOWM0MWJjMTJiZmMxZDE1MzVjMTY3MjEyY2EzMjlhNTIzNiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.qGJHg9WguHQZ9Hixk3DS_rmaZZd6eQJNpeJykSMQpbw). Thanks to [jhroy](https://github.com/jhroy).
 #' @usage ca_quebec_electoral_districts_grid1
 #' @rdname grids
 #' @md
@@ -714,15 +714,15 @@ NULL
 
 #' @name cn_bj_districts_grid2
 #' @description
-#' * **cn_bj_districts_grid2:** Grid with districts of Beijing, China Image reference [here](https://camo.githubusercontent.com/c32d419c0b3d10fa007e68a66bf368752a45f8a9/68747470733a2f2f677373302e62647374617469632e636f6d2f2d346f33645361675f7849346b68476b706f574b314846366868792f6261696b652f63302533446261696b65313530253243352532433525324331353025324335302f7369676e3d34396436313237373464313062393132616263636665616361323934393736362f643034336164346264313133373366303036633533613533616530663462666266616564303430372e6a7067). Thanks to [zouhx11](https://github.com/zouhx11).
+#' * **cn_bj_districts_grid2:** Grid with districts of Beijing, China Image reference [here](https://user-images.githubusercontent.com/1275592/54295842-0ccea100-4571-11e9-8d3f-c60f4f7f2c0a.png). Thanks to [zouhx11](https://github.com/zouhx11).
 #' @usage cn_bj_districts_grid2
 #' @rdname grids
 #' @md
 NULL
 
 #' @name ar_santiago_del_estero_prov_grid1
 #' @description
-#' * **ar_santiago_del_estero_prov_grid1:** Grid with districts of Santiago del Estero Province, Argentina Image reference [here](https://camo.githubusercontent.com/82e68c0a0f0b243c8a9d21133227f74e05c93c6b/68747470733a2f2f74342e6b6e332e6e65742f746172696e67612f302f382f312f362f362f312f4d6565656b69692f3631382e6a7067). Thanks to [TuQmano](https://github.com/TuQmano).
+#' * **ar_santiago_del_estero_prov_grid1:** Grid with districts of Santiago del Estero Province, Argentina Image reference [here](https://camo.githubusercontent.com/5b7e451b3ccc8550c31644cf897c096256cc01ffc9c7f7f0a1284b29389fa34a/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f622f62382f446570617274616d656e746f5f416775697272655f25323853616e746961676f5f64656c5f45737465726f5f2d5f417267656e74696e612532392e706e67). Thanks to [TuQmano](https://github.com/TuQmano).
 #' @usage ar_santiago_del_estero_prov_grid1
 #' @rdname grids
 #' @md
@@ -746,15 +746,15 @@ NULL
 
 #' @name ar_catamarca_prov_grid1
 #' @description
-#' * **ar_catamarca_prov_grid1:** Grid with districts of Catamarca Province, Argentina Image reference [here](https://camo.githubusercontent.com/8a25c2986d42003208644618e0e3d3c1950fcd92/687474703a2f2f7777772e616c6c2d617267656e74696e612e636f6d2e61722f77702d636f6e74656e742f75706c6f6164732f6d6170612d706f6c697469636f2d636174616d617263612e6a7067). Thanks to [TuQmano](https://github.com/TuQmano).
+#' * **ar_catamarca_prov_grid1:** Grid with districts of Catamarca Province, Argentina Image reference [here](https://camo.githubusercontent.com/a5997d24eda54a3ebce19a8bad590348e3926142db79d665c9a8c17b72c08d3c/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f7468756d622f322f32372f416d6261746f5f25323850726f76696e6369615f64655f436174616d617263615f2d5f417267656e74696e612532392e7376672f3139323070782d416d6261746f5f25323850726f76696e6369615f64655f436174616d617263615f2d5f417267656e74696e612532392e7376672e706e67). Thanks to [TuQmano](https://github.com/TuQmano).
 #' @usage ar_catamarca_prov_grid1
 #' @rdname grids
 #' @md
 NULL
 
 #' @name ar_jujuy_prov_grid1
 #' @description
-#' * **ar_jujuy_prov_grid1:** Grid with districts of Jujuy Province, Argentina Image reference [here](https://camo.githubusercontent.com/df150ce3e47d85c63efc43a5614f5f6366970669/687474703a2f2f7777772e64697065632e6a756a75792e676f762e61722f6d617061735f6a756a75795f63656e736f2f6a756a7579646570617274616d656e746f732e676966). Thanks to [TuQmano](https://github.com/TuQmano).
+#' * **ar_jujuy_prov_grid1:** Grid with districts of Jujuy Province, Argentina Image reference [here](https://camo.githubusercontent.com/9ccfff93636f3067deca6ead3cd7320ef0ff76b0f6628541baf2f17f9a612e14/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f7468756d622f372f37662f436f6368696e6f63615f25323850726f76696e6369615f64655f4a756a75795f2d5f417267656e74696e612532392e7376672f3235363070782d436f6368696e6f63615f25323850726f76696e6369615f64655f4a756a75795f2d5f417267656e74696e612532392e7376672e706e67). Thanks to [TuQmano](https://github.com/TuQmano).
 #' @usage ar_jujuy_prov_grid1
 #' @rdname grids
 #' @md
@@ -898,15 +898,15 @@ NULL
 
 #' @name fr_departements_grid1
 #' @description
-#' * **fr_departements_grid1:** Grid for France's departements, the second levels of administrative boundaries after the regions Image reference [here](https://camo.githubusercontent.com/6c082d52645d75469d542aefed9ef2feb48b2247/68747470733a2f2f7777772e616964656d6f692e6e65742f67656f677261706869652f6672616e63652f646570617274656d656e745f7265647569742e676966). Thanks to [tvroylandt](https://github.com/tvroylandt).
+#' * **fr_departements_grid1:** Grid for France's departements, the second levels of administrative boundaries after the regions Image reference [here](https://private-user-images.githubusercontent.com/1275592/286455090-673ae153-092d-4632-ab43-d6be18139a1c.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTEiLCJleHAiOjE3MDEyMjUwMjAsIm5iZiI6MTcwMTIyNDcyMCwicGF0aCI6Ii8xMjc1NTkyLzI4NjQ1NTA5MC02NzNhZTE1My0wOTJkLTQ2MzItYWI0My1kNmJlMTgxMzlhMWMucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQUlXTkpZQVg0Q1NWRUg1M0ElMkYyMDIzMTEyOSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyMzExMjlUMDIyNTIwWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9MzU5MDY3YzhhYjQ2OWIxYjdmYTc4MDI2NjM0ZGRhYTBkNjMwOTEyYWFkZmZlNjY2MzA0MmFhMjMyNDUwZDA3MSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.-V_AHDxiL3yAkk-oJAUYtdLM74O-_3ITjSYzU5-G8lo). Thanks to [tvroylandt](https://github.com/tvroylandt).
 #' @usage fr_departements_grid1
 #' @rdname grids
 #' @md
 NULL
 
 #' @name ar_salta_prov_grid2
 #' @description
-#' * **ar_salta_prov_grid2:** Grids for Salta Province Argentina Image reference [here](https://camo.githubusercontent.com/7ced09c1b65c46671c333cc13acbaf864eaa358b/68747470733a2f2f7777772e616d657473616c74612e636f6d2e61722f7765622f696d616765732f616e69766572736172696f732f32343430343436322e6a7067). Thanks to [tartagalensis](https://github.com/tartagalensis).
+#' * **ar_salta_prov_grid2:** Grids for Salta Province Argentina Image reference [here](https://camo.githubusercontent.com/bd75334802b6ef199dca758018335f162671c1d1e95147d9dabd4b0dc0d18f2c/687474703a2f2f312e62702e626c6f6773706f742e636f6d2f5f564a6b71374771783743512f52303349467549766e30492f41414141414141414141632f75336655614c744e6a53672f733430302f646570617274616d656e746f732b64652b53616c74612e6a7067). Thanks to [tartagalensis](https://github.com/tartagalensis).
 #' @usage ar_salta_prov_grid2
 #' @rdname grids
 #' @md
@@ -1010,7 +1010,7 @@ NULL
 
 #' @name sg_planning_area_grid2
 #' @description
-#' * **sg_planning_area_grid2:** Singapore Planning Areas Image reference [here](https://camo.githubusercontent.com/46010d480fc21b0e42dcdbd6a56c467e2dbe094d/68747470733a2f2f6f666f6d6170732e636f6d2f77702d636f6e74656e742f75706c6f6164732f6564642f323031392f30362f53696e6761706f72655f4d61702d352d323830783238302e676966). Thanks to [ZhimaoElliott](https://github.com/ZhimaoElliott).
+#' * **sg_planning_area_grid2:** Singapore Planning Areas Image reference [here](https://user-images.githubusercontent.com/1275592/54297744-a9467280-4574-11e9-99f7-bdb62bbb34b4.png). Thanks to [ZhimaoElliott](https://github.com/ZhimaoElliott).
 #' @usage sg_planning_area_grid2
 #' @rdname grids
 #' @md
@@ -1106,7 +1106,7 @@ NULL
 
 #' @name us_wi_counties_grid1
 #' @description
-#' * **us_wi_counties_grid1:** Grid layout for counties of Wisconsin, United States Image reference [here](https://camo.githubusercontent.com/493b3324ca2680e299745b72c46ddfb7ab6bbf08/68747470733a2f2f7777772e6468732e776973636f6e73696e2e676f762f73697465732f64656661756c742f66696c65732f77692d636f756e746965732e676966). Thanks to [aravamu2](https://github.com/aravamu2).
+#' * **us_wi_counties_grid1:** Grid layout for counties of Wisconsin, United States Image reference [here](https://camo.githubusercontent.com/0e8c590b5984c2b061abdb1cf3d81c25a1dfd74828995f4aedc4bf8021c9e942/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f322f32352f576973636f6e73696e2d636f756e746965732d6d61702e676966). Thanks to [aravamu2](https://github.com/aravamu2).
 #' @usage us_wi_counties_grid1
 #' @rdname grids
 #' @md
@@ -1122,7 +1122,7 @@ NULL
 
 #' @name no_counties_grid1
 #' @description
-#' * **no_counties_grid1:** Grid of counties of Norway Image reference [here](https://camo.githubusercontent.com/278d9052a0d7dbb686c4ca655ba212657347835f/68747470733a2f2f7777772e7265736561726368676174652e6e65742f7075626c69636174696f6e2f3332313936373831352f6669677572652f666967312f41533a35373430303139333338313939303440313531333836343133333538352f436f756e746965732d696e2d4e6f727761792d7065722d446563656d6265722d323031372d6e756d62657265642d6163636f7264696e672d746f2d537461746973746963732d4e6f727761792d4d61702d736f757263652e706e67). Thanks to [NanAmalie1](https://github.com/NanAmalie1).
+#' * **no_counties_grid1:** Grid of counties of Norway Image reference [here](https://camo.githubusercontent.com/1e8684781a30cdc9ce1b87068c861ebdfd51548f41de95d073217037cf9defb4/68747470733a2f2f7777772e66616d696c797365617263682e6f72672f656e2f77696b692f696d675f617574682e7068702f362f36632f4e6f727761795f3278322e6a7067). Thanks to [NanAmalie1](https://github.com/NanAmalie1).
 #' @usage no_counties_grid1
 #' @rdname grids
 #' @md