Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

should `build_win` use `manual = TRUE`? #1890

Closed
topepo opened this Issue Oct 16, 2018 · 5 comments

Comments

Projects
None yet
3 participants
@topepo
Copy link
Member

topepo commented Oct 16, 2018

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

This comment has been minimized.

Copy link
Member

gaborcsardi commented Oct 16, 2018

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

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

@jimhester

This comment has been minimized.

Copy link
Member

jimhester commented Oct 16, 2018

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

This comment has been minimized.

Copy link
Member

gaborcsardi commented Oct 16, 2018

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

@jimhester jimhester closed this in 22ac85a Oct 16, 2018

@gaborcsardi

This comment has been minimized.

Copy link
Member

gaborcsardi commented Oct 16, 2018

Thanks!

@lock

This comment has been minimized.

Copy link

lock bot commented Apr 14, 2019

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/

@lock lock bot locked and limited conversation to collaborators Apr 14, 2019

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
You can’t perform that action at this time.