Skip to content

Commit

Permalink
pkgdown implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
nmueller18 committed Jan 12, 2025
1 parent 28512a1 commit e4b1a21
Show file tree
Hide file tree
Showing 4 changed files with 89 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
49 changes: 49 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# 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:
release:
types: [published]
workflow_dispatch:

name: pkgdown.yaml

permissions: read-all

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@v4

- 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
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ Depends:
RdMacros: Rdpack
VignetteBuilder: knitr
Config/testthat/edition: 3
URL: https://github.com/ISAAKiel/mortAAR
URL: https://github.com/ISAAKiel/mortAAR, https://isaakiel.github.io/mortAAR/
BugReports: https://github.com/ISAAKiel/mortAAR/issues
38 changes: 38 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
url: https://isaakiel.github.io/mortAAR/
template:
bootstrap: 5

reference:
- title: "Basic functions"
contents:
- prep.life.table
- life.table
- plot
- print
- title: "Advanced functions"
contents:
- lt.representativity
- lt.correction
- lt.reproduction
- lt.sexrelation
- lt.population_size
- halley.band
- title: "Helper functions"
contents:
- lt.indices
- pop.sim.gomp
- random.cat
- random.cat.apply
- mortaar_life_table
- as.mortaar_life_table
- as.mortaar_life_table_list
- title: "Life table examples"
contents:
- aiterhofen_oedmuehlen
- gallery_graves
- magdalenenberg
- muensingen
- nitra
- odagsen_cm
- odagsen_mo
- schleswig_ma

0 comments on commit e4b1a21

Please sign in to comment.