step_build_pkgdown

Arguments passed on to <code>pkgdown::build_site</code><dl class="dl-horizontal">
 <dt>pkg</dt><dd>Path to package.</dd>
 <dt>examples</dt><dd>Run examples?</dd>
 <dt>document</dt><dd>If <code>TRUE</code>, will run <code><a rd-options="devtools:document" href="/link/devtools%3A%3Adocument()?package=tic&version=0.2.13.9015&to=devtools%3Adocument" data-mini-rdoc="devtools:document::devtools::document()">devtools::document()</a></code> before
updating the site.</dd>
 <dt>run_dont_run</dt><dd>Run examples that are surrounded in \dontrun?</dd>
 <dt>seed</dt><dd>Seed used to initialize so that random examples are
reproducible.</dd>
 <dt>lazy</dt><dd>If <code>TRUE</code>, will only rebuild articles and reference pages
if the source is newer than the destination.</dd>
 <dt>override</dt><dd>An optional named list used to temporarily override
values in <code>_pkgdown.yml</code></dd>
 <dt>preview</dt><dd>If <code>TRUE</code>, or <code>is.na(preview) &amp;&amp; interactive()</code>, will preview
freshly generated section in browser.</dd>
 <dt>new_process</dt><dd>If <code>TRUE</code>, will run <code>build_site()</code> in a separate process.
This enhances reproducibility by ensuring nothing that you have loaded
in the current process affects the build process.</dd>
</dl>

Builds package documentation with the pkgdown package.
Calls <code>pkgdown::clean_site()</code> and then <code>pkgdown::build_site(...)</code>.


Provides a way to describe common build and deployment workflows for R-based
projects: packages, websites (e.g. blogdown, pkgdown), or data processing
(e.g. research compendia).  The recipe is described independent of the
continuous integration tool used for processing the workflow (e.g.
'Travis CI' or 'AppVeyor').

Kirill Müller

Tasks Integrating Continuously: CI-Agnostic Workflow Definitions

Patrick Schratz

Mika Braginsky

Karthik Ram

Jeroen Ooms

rOpenSci 

step_build_pkgdown function

Arguments passed on to <code>pkgdown::build_site</code><dl class='dl-horizontal'>
 <dt>pkg</dt><dd>Path to package.</dd>
 <dt>examples</dt><dd>Run examples?</dd>
 <dt>document</dt><dd>If <code>TRUE</code>, will run <code><a rd-options='devtools:document' href='devtools::document()'>devtools::document()</a></code> before
updating the site.</dd>
 <dt>run_dont_run</dt><dd>Run examples that are surrounded in \dontrun?</dd>
 <dt>seed</dt><dd>Seed used to initialize so that random examples are
reproducible.</dd>
 <dt>lazy</dt><dd>If <code>TRUE</code>, will only rebuild articles and reference pages
if the source is newer than the destination.</dd>
 <dt>override</dt><dd>An optional named list used to temporarily override
values in <code>_pkgdown.yml</code></dd>
 <dt>preview</dt><dd>If <code>TRUE</code>, or <code>is.na(preview) &amp;&amp; interactive()</code>, will preview
freshly generated section in browser.</dd>
 <dt>new_process</dt><dd>If <code>TRUE</code>, will run <code>build_site()</code> in a separate process.
This enhances reproducibility by ensuring nothing that you have loaded
in the current process affects the build process.</dd>
</dl>

step_build_pkgdown: Step: Build pkgdown documentation

Description

Usage

Arguments

See Also