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.

Sign up for GitHub

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

Jump to bottom

use_vignettes() should .gitignore inst/doc #584

Closed
hadley opened this issue Sep 16, 2014 · 6 comments
Closed

use_vignettes() should .gitignore inst/doc #584

hadley opened this issue Sep 16, 2014 · 6 comments

Comments

@hadley
Copy link
Member

hadley commented Sep 16, 2014

(because it shouldn't be checked in)
@hadley hadley closed this as completed in 9bb78f1 Sep 16, 2014
@jtr13
Copy link

jtr13 commented Aug 16, 2017

Why? Isn't it more efficient to have the built vignettes on Github rather than use build_vignettes = TRUE w/ install_github()? More discussion here: STAT545-UBC/Discussion#68

@hadley
Copy link
Member Author

hadley commented Aug 17, 2017

Because it causes problems with R CMD check - I'm reasonably certain that saving built vignettes in inst/doc is the wrong approach

@jtr13
Copy link

jtr13 commented Aug 17, 2017

I'll trust your instincts. So, to confirm, the right approach is to instruct users on Github to add build_vignettes = TRUE? Surprising this is rarely done, AFAIK.

@hadley
Copy link
Member Author

hadley commented Aug 17, 2017

We'll fix this in devtools eventually - see #1578

@jtr13
Copy link

jtr13 commented Aug 17, 2017

Got it, thanks.

adblackwell pushed a commit to adblackwell/localgrowth that referenced this issue Jun 21, 2018
Added build vignette by removing inst/doc from .gitignore. May not be…
3b5308b 
… right approach, but easiest. See r-lib/devtools#584
@lock
Copy link

lock bot commented Sep 17, 2018

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 Sep 17, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hadley @jtr13