Skip to content

Commit e94041c

Browse files
committed
Set up pkgdown documentation website
- Add pkgdown configuration (_pkgdown.yml) - Set up GitHub Pages workflow for automatic site updates - Add hex sticker to man/figures/ for proper pkgdown display - Update README.md to reference correct sticker path - Configure site URL: https://maxmlang.github.io/hexsmoothR/ - Package now has professional documentation website
1 parent 1dcfe58 commit e94041c

7 files changed

Lines changed: 59 additions & 2 deletions

File tree

.Rbuildignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,6 @@ Thumbs.db
2626
^Meta$
2727
^cran-comments\.md$
2828
^\.github$
29+
^_pkgdown\.yml$
30+
^docs$
31+
^pkgdown$

.github/workflows/pkgdown.yaml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
release:
8+
types: [published]
9+
workflow_dispatch:
10+
11+
name: pkgdown.yaml
12+
13+
permissions: read-all
14+
15+
jobs:
16+
pkgdown:
17+
runs-on: ubuntu-latest
18+
# Only restrict concurrency for non-PR jobs
19+
concurrency:
20+
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
21+
env:
22+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
23+
permissions:
24+
contents: write
25+
steps:
26+
- uses: actions/checkout@v4
27+
28+
- uses: r-lib/actions/setup-pandoc@v2
29+
30+
- uses: r-lib/actions/setup-r@v2
31+
with:
32+
use-public-rspm: true
33+
34+
- uses: r-lib/actions/setup-r-dependencies@v2
35+
with:
36+
extra-packages: any::pkgdown, local::.
37+
needs: website
38+
39+
- name: Build site
40+
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
41+
shell: Rscript {0}
42+
43+
- name: Deploy to GitHub pages 🚀
44+
if: github.event_name != 'pull_request'
45+
uses: JamesIves/github-pages-deploy-action@v4.5.0
46+
with:
47+
clean: false
48+
branch: gh-pages
49+
folder: docs

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,4 @@ output/
7979

8080
# Version control
8181
/.git/
82+
docs

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ Suggests:
2929
VignetteBuilder: knitr
3030
RoxygenNote: 7.3.2
3131
SystemRequirements: GDAL (>= 3.0), GEOS (>= 3.8), PROJ (>= 6.0)
32-
32+
URL: https://maxmlang.github.io/hexsmoothR/

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# hexsmoothR: Hexagonal Grid Smoothing for Satellite Data
22

33
<div align="center">
4-
<img src="inst/images/hexsmoothR_sticker.png" alt="hexsmoothR hex sticker" width="200">
4+
<img src="man/figures/hexsmoothR_sticker.png" alt="hexsmoothR hex sticker" width="200">
55
</div>
66

77
<!-- badges: start -->

_pkgdown.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
url: https://maxmlang.github.io/hexsmoothR/
2+
template:
3+
bootstrap: 5
4+

man/figures/hexsmoothR_sticker.png

903 KB
Loading

0 commit comments

Comments
 (0)