rotemplate provides a custom pkgdown template for rOpenSci packages. We use this to render sites at https://docs.ropensci.org. Please don’t use it for your own package if it’s not an rOpenSci package (i.e. only use it for packages listed on https://ropensci.org/packages/).
Inspired by tidytemplate and lockedatapkg.
How to use rotemplate
Documentation for rOpenSci packages will automatically be generated from your default branch and published to https://docs.ropensci.org. You don’t need to do anything to make this work. To test your site locally use:
library(rotemplate)
#install.packages("yourpkg")
rotemplate::build_ropensci_docs("path/to/yourpkg")Preferences can be configured as usual via the _pkgdown.yml file as described in the pkgdown documentation.
If your website is not deploying or you run into another problem, please open an issue in the rotemplate repository.
How it works
The R-universe build workflow automatically invokes the rotemplate action.yml script on each update of a packages in ropensci. You don’t need to do anything for this. However, if you want to test-build the pkgdown site in your own package CI, you could add the following test workflow to your package repository:
on:
push:
pull_request:
name: Test-docs
jobs:
Test-docs:
runs-on: ubuntu-latest
steps:
- uses: ropensci-org/rotemplate@mainThis will run exactly the same script to build the ropensci pkgdown site, and store it as an GHA artifact where you can download it to view it locally.
Math rendering
Please refer to pkgdown documentation.