Skip to content

Commit 21b8cbf

Browse files
docs: Set up pkgdown website with automated GitHub Pages deployment
Co-authored-by: aider (gemini/gemini-2.5-pro) <aider@aider.chat>
1 parent fbd34fe commit 21b8cbf

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed

.github/workflows/pkgdown.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
- master
6+
workflow_dispatch:
7+
8+
name: pkgdown
9+
10+
jobs:
11+
pkgdown:
12+
runs-on: ubuntu-latest
13+
env:
14+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
15+
permissions:
16+
contents: write
17+
steps:
18+
- uses: actions/checkout@v3
19+
20+
- uses: r-lib/actions/setup-r@v2
21+
with:
22+
use-public-rspm: true
23+
24+
- uses: r-lib/actions/setup-r-dependencies@v2
25+
with:
26+
extra-packages: any::pkgdown, local::.
27+
needs: pkgdown
28+
29+
- name: Build and deploy site
30+
run: pkgdown::build_site_github_pages()
31+
shell: Rscript {0}

DESCRIPTION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Imports:
2222
Depends:
2323
R (>= 4.1.0)
2424
Suggests:
25+
pkgdown (>= 2.0.0),
2526
testthat (>= 3.0.0),
2627
label.switching (>= 1.8)
2728
Config/testthat/edition: 3

_pkgdown.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
url: https://oystein-sorensen.github.io/BayesMallowsSMC2
2+
template:
3+
bootstrap: 5
4+
5+
navbar:
6+
components:
7+
reference:
8+
text: Reference
9+
href: reference/index.html
10+
news:
11+
text: Changelog
12+
href: news/index.html
13+
14+
reference:
15+
- title: "Main function"
16+
contents:
17+
- compute_sequentially
18+
- title: "Helper functions"
19+
contents:
20+
- set_hyperparameters
21+
- set_smc_options
22+
- precompute_topological_sorts

0 commit comments

Comments
 (0)