diff --git a/.Rbuildignore b/.Rbuildignore index a4f6cb8..69e5b88 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -8,3 +8,6 @@ ^codecov\.yml$ ^cran-comments\.md$ ^CRAN-SUBMISSION$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..ed7650c --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -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/github-pages-deploy-action@v4.4.1 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index d5a36a0..05c2632 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ .RData .Ruserdata .httr-oauth +docs diff --git a/DESCRIPTION b/DESCRIPTION index 79e2c5f..563e9bb 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -9,7 +9,7 @@ Authors@R: email = "david@schochastics.net", comment = c(ORCID = "0000-0003-2952-4812")) Description: Connects to the API of to search for 'Reddit' comments and submissions. -URL: https://github.com/schochastics/PSAWR/ +URL: https://github.com/schochastics/PSAWR/, https://schochastics.github.io/PSAWR/ BugReports: https://github.com/schochastics/PSAWR/issues License: MIT + file LICENSE Encoding: UTF-8 diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..c83303b --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,18 @@ +url: https://schochastics.github.io/PSAWR/ +template: + bootstrap: 5 + bslib: + bg: "#F9F7F7" + fg: "#112D4E" + primary: "#3F72AF" + navbar-color: "#FFFFFF" + base_font: {google: "Roboto"} + heading_font: {google: "Roboto Slab"} + code_font: {google: "JetBrains Mono"} +navbar: + bg: none + type: light + structure: + left: [intro, reference, articles, news] + right: [github] +