Skip to content

Commit

Permalink
docs: add pkgdown
Browse files Browse the repository at this point in the history
  • Loading branch information
jimbrig committed Dec 13, 2024
1 parent 76f4c90 commit a141fc2
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 36 deletions.
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 @@ -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)
Expand Down
57 changes: 22 additions & 35 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,42 +1,29 @@
url: https://docs.noclocks.dev/gmhcommunities

url: http://docs.noclocks.dev/gmhcommunities/
template:
bootstrap: 5
includes:
in_header:
<script defer data-domain="docs.noclocks.dev" src="https://plausible.io/js/plausible.js"></script>

in_header: <script defer data-domain="docs.noclocks.dev" src="https://plausible.io/js/plausible.js"></script>
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_")

0 comments on commit a141fc2

Please sign in to comment.