should build_win use manual = TRUE?

[topepo]

generics has some \Sexpr in the man files but the build_win process came up with the note:

Package has help file(s) containing install/render-stage \Sexpr{} expressions but no prebuilt PDF manual.

[gaborcsardi]

check_win() should probably call build with manual = TRUE here:

devtools/R/check-win.R

Line 60 in 95ba765

built_path <- pkgbuild::build(pkg$path, tempdir(), args = args, quiet = quiet, ...)

[jimhester]

The devel version of devtools passes ... to pkgbuild::build(), so you just need to specify manual = TRUE in this case.

I am not really sure we should necessarily change the default as building the manual requires a LaTeX installation, which not everyone will have.

[gaborcsardi]

AFAIK only if the package has \Sexpr, in which case you do need latex. For manual = FALSE it just omits the --no-manual flag, and R CMD build decides automatically:

❯ R  CMD build --help
Usage: R CMD build [options] pkgdirs

Build R packages from package sources in the directories specified by
‘pkgdirs’

Options:
  -h, --help		print short help message and exit
[...]
  --no-manual           do not build the PDF manual even if \Sexprs are present

[gaborcsardi]

Thanks!

[lock]

This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/