![](https://atmoschem.github.io/EmissV/logo.png)
diff --git a/.Rbuildignore b/.Rbuildignore index b48bace..03f5792 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -16,3 +16,6 @@ ^codecov\.yml$ ^.github inst/extdata/dmsp_hi-res.tiff +^_pkgdown\.yml$ +^pkgdown$ +^\.github$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ 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..c9f0165 --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,50 @@ +# 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 + +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/.gitignore b/.gitignore index adb1aa9..363f44e 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ .RData paper.pdf tests/testthat/Rplots.pdf +docs diff --git a/README.md b/README.md index c2ccb4b..86f8c2e 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,6 @@ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1451027.svg)](https://doi.org/10.5281/zenodo.1451027) [![status](http://joss.theoj.org/papers/071d027997ac93d8992099cb5010a044/status.svg)](http://joss.theoj.org/papers/071d027997ac93d8992099cb5010a044) -![hex_logo](https://raw.githubusercontent.com/atmoschem/EmissV/master/hex_logo_true.png) - This package provides tools to create emissions (with a focus on vehicular emissions) for use in numeric air quality models such as [WRF-Chem](https://ruc.noaa.gov/wrf/wrf-chem/). ## Installation diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..8a97949 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: https://atmoschem.github.io/EmissV/ +template: + bootstrap: 5 + light-switch: true diff --git a/docs/404.html b/docs/404.html index 961f760..89e92b8 100644 --- a/docs/404.html +++ b/docs/404.html @@ -4,100 +4,86 @@ - +