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

Packaged don't find vignettes created with use-vignette #931

Closed
smach opened this issue Sep 17, 2015 · 6 comments
Closed

Packaged don't find vignettes created with use-vignette #931

smach opened this issue Sep 17, 2015 · 6 comments
Labels
feature a feature request or enhancement load

Comments

@smach
Copy link

smach commented Sep 17, 2015

Packages don't "find" vignettes created with use-vignette() -- that is, they're not listed in the package help or when runningvignette() and browseVignettes() -- without also running build_vignette(). Issue filed per this Twitter thread https://twitter.com/sharon000/status/644256000451694592

@jennybc
Copy link
Member

jennybc commented Nov 12, 2015

What IS the official party line on how to manage vignettes during development?

In your book, vignette workflow addresses the (ephemeral) preview. And development cycle gets at the other end ... when building and installing a package properly.

What about the bit in the middle?

@hadley
Copy link
Member

hadley commented Nov 12, 2015

I preview them with Cmd + Shift + K. What else do you need to do during dev?

@jennybc
Copy link
Member

jennybc commented Nov 12, 2015

I'm thinking about the vignettes relative to what we do for roxygen comment / Rd file (and README.Rmd / README.md?).

The documentation workflow results in persistent help files you can preview in their natural habitat with ?. What's the equivalent for a vignette? The Cmd + Shift + K preview can be a drag because sometimes they take a long time to render.

It's not that I can't figure out how get a rendered vignette. It's about figuring out the most devtools-ish way to get and possibly hold on to them.

@hadley
Copy link
Member

hadley commented Nov 12, 2015

Oh hmmmm, maybe we need a vignette() shim to get the dev version?

@hadley
Copy link
Member

hadley commented Aug 2, 2017

Moved to pkgload

@hadley hadley closed this as completed Aug 2, 2017
@lock
Copy link

lock bot commented Sep 18, 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 18, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature a feature request or enhancement load
Projects
None yet
Development

No branches or pull requests

3 participants