Skip to content

Commit

Permalink
create pkgdown site
Browse files Browse the repository at this point in the history
  • Loading branch information
shanejorr committed Sep 26, 2023
1 parent ca29d89 commit e0552af
Show file tree
Hide file tree
Showing 22 changed files with 70 additions and 2,923 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@
^docs$
^pkgdown$
^README\.Rmd$
^\.github$
^vignettes/tntp-style-plots\.rmd$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
48 changes: 48 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Description: An internal TNTP R package that includes functions and
package to be a one-stop shop for R tools by analysts and other data
users at TNTP.
License: CC BY 4.0
URL: https://github.com/tntp/tntpr
URL: https://github.com/tntp/tntpr, https://tntp.github.io/tntpr/
Depends:
R (>= 3.2)
Imports:
Expand Down
12 changes: 11 additions & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
url: 'https://tntp.github.io/tntpr/'
url: https://tntp.github.io/tntpr/

articles:
- title: Articles
navbar: ~
contents:
- tntpr-introduction
- visualization-cookbook
- date_to_sy_worked_example
- factorizing_a_dataset
- tntp-style-plots

template:
bootstrap: 5
Expand Down
26 changes: 0 additions & 26 deletions docs/date_to_sy_worked_example.R

This file was deleted.

52 changes: 0 additions & 52 deletions docs/date_to_sy_worked_example.Rmd

This file was deleted.

Loading

0 comments on commit e0552af

Please sign in to comment.