diff --git a/.github/.gitignore b/.github/.gitignore index e69de29..2d19fc7 100644 --- a/.github/.gitignore +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..bfc9f4d --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -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/github-pages-deploy-action@v4.5.0 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/DESCRIPTION b/DESCRIPTION index 6c3b66c..90454fd 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -10,7 +10,7 @@ Authors@R: c( Description: Provides a suite of tools for working with the GMH Communities Data Hub Platform. License: MIT + file LICENSE -URL: https://github.com/noclocks/gmhdatahub +URL: https://github.com/noclocks/gmhdatahub, http://docs.noclocks.dev/gmhcommunities/ BugReports: https://github.com/noclocks/gmhdatahub/issues Depends: R (>= 4.1) diff --git a/_pkgdown.yml b/_pkgdown.yml index 3c8599c..e4a06fd 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,42 +1,29 @@ -url: https://docs.noclocks.dev/gmhcommunities - +url: http://docs.noclocks.dev/gmhcommunities/ template: bootstrap: 5 includes: - in_header: - - + in_header: development: mode: auto - reference: +- title: Entrata API + desc: | + Functions to interact with the Entrata API. + contents: starts_with("entrata_") +- title: Database + desc: | + Functions to interact with the backend database. + contents: starts_with("db_") +- title: Shiny App + desc: | + Core Shiny App Functions + contents: starts_with("app_") +- title: Shiny Modules + desc: | + Shiny Modules + contents: starts_with("mod_") +- title: Utilities + desc: | + Utility Functions + contents: starts_with("utils_") - - title: Entrata API - desc: > - Functions to interact with the Entrata API. - contents: - - starts_with("entrata_") - - - title: Database - desc: > - Functions to interact with the backend database. - contents: - - starts_with("db_") - - - title: Shiny App - desc: > - Core Shiny App Functions - contents: - - starts_with("app_") - - - title: Shiny Modules - desc: > - Shiny Modules - contents: - - starts_with("mod_") - - - title: Utilities - desc: > - Utility Functions - contents: - - starts_with("utils_")