.github/actions/build_pkgdown_site/README.md

In ebimodeling/biocro: Modular Crop Growth Simulations

The Build pkgdown site action

This action builds the pkgdown documentation for the BioCro package using the pkgdown configuration file found in this directory. The output files are written to the default location, a subdirectory of the package root called docs.

Preconditions

• The BioCro repository must be checked out to the GitHub workspace

• R must be set up on the GitHub runner

• Package dependencies of the package being documented (BioCro) must be installed

• The pkgdown R package must be installed

This action will take care of installing Pandoc if it hasn't been installed already. It will also install the tinytex R package along with a corresponding TinyTex LaTeX installation and any extra LaTeX packages needed by the vignettes.

Inputs

'package_root'

Optional This should be the relative path from the GitHub workspace directory to the root directory of the BioCro source tree. Default: '.'

'base_url'

Optional If provided, this will be the setting for url in the pkgdown configuration file.

ebimodeling/biocro documentation built on May 3, 2024, 7:52 p.m.