.github/actions/render_bookdown_book/README.md

In ebimodeling/biocro: Modular Crop Growth Simulations

The Render Bookdown Book action

This action builds the Bookdown documentation for the BioCro package. The output files are written to the default location, the directory bookdown/_book relative to the package root directory.

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.

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: '.'

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