Skip to content

Commit

Permalink
Add pkgdown
Browse files Browse the repository at this point in the history
  • Loading branch information
chainsawriot committed Mar 25, 2024
1 parent 230cb33 commit 07a58ae
Show file tree
Hide file tree
Showing 8 changed files with 54 additions and 4 deletions.
4 changes: 4 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@
^cran-comments\.md$
^CRAN-SUBMISSION$
^.gitattributes$
^_pkgdown\.yml$
^docs$
^pkgdown$
^\.github$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
38 changes: 38 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
on:
push:
branches: v*
pull_request:
branches: v*
release:
types: published
workflow_dispatch: ~
name: pkgdown
jobs:
pkgdown:
runs-on: ubuntu-latest
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: yes
- 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 \U0001F680"
if: github.event_name != 'pull_request'
uses: JamesIves/[email protected]
with:
clean: no
branch: gh-pages
folder: docs
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
inst/doc
docs
5 changes: 3 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: grafzahl
Title: Supervised Machine Learning for Textual Data Using Transformers and 'Quanteda'
Version: 0.0.9
Version: 0.0.10
Authors@R:
person("Chung-hong", "Chan", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-6232-7530"))
Expand All @@ -9,7 +9,7 @@ License: GPL (>= 3)
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.1
URL: https://github.com/gesistsa/grafzahl
URL: https://gesistsa.github.io/grafzah, https://github.com/gesistsa/grafzahl
BugReports: https://github.com/gesistsa/grafzahl/issues
Suggests:
knitr,
Expand All @@ -29,3 +29,4 @@ LazyData: true
Depends:
R (>= 3.5)
VignetteBuilder: knitr
Config/Needs/website: gesistsa/tsatemplate
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ knitr::opts_chunk$set(
)
```

# grafzahl <img src="man/figures/grafzahl_logo.svg" align="right" height="200" />
# grafzahl <img src="man/figures/grafzahl_logo.svg" align="right" height="139" />

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/grafzahl)](https://CRAN.R-project.org/package=grafzahl)
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# grafzahl <img src="man/figures/grafzahl_logo.svg" align="right" height="200" />
# grafzahl <img src="man/figures/grafzahl_logo.svg" align="right" height="139" />

<!-- badges: start -->

Expand Down
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: https://gesistsa.github.io/grafzahl/
template:
package: tsatemplate

0 comments on commit 07a58ae

Please sign in to comment.