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

devtools::build_vignettes and rstudio build->install and restart #1809

Closed
wolski opened this issue Jul 3, 2018 · 2 comments
Closed

devtools::build_vignettes and rstudio build->install and restart #1809

wolski opened this issue Jul 3, 2018 · 2 comments
Labels
feature a feature request or enhancement vignettes 📜
Milestone
2.0.0

Comments

@wolski
Copy link

wolski commented Jul 3, 2018

Hello,

There is a difference between devtools and the rstudio behaviour although although I configured the package build in rstudio to use devtools.

When building vignettes with devtools::build_vignettes they end up in inst/doc
and also the package index is updated so that they are visible in the package documentation.

When building vignettes with rstudio -> install and restart, the vignettes are build but the html and pdf version do remain in the vignettes folder and do not show up in the package documentation.

These are my rstudio build settings.

rstudiosettings

I am wondering if this is something to be expected.

I wish you a great day.
Best regards
@jimhester
Copy link
Member

It is expected, we are planning to re-think how devtools builds vignettes #1578.

@jimhester jimhester added the feature a feature request or enhancement label Jul 5, 2018
@jimhester jimhester added this to the 2.0.0 milestone Jul 18, 2018
jimhester added a commit that referenced this issue Jul 20, 2018
@jimhester
Use better vignette workflow
3fa1ae9 
This installs the built vignettes to doc/ rather than inst/doc and
builds a vignette index in Meta/vignette.rds. This means that you can
view development vignettes by loading the package with `load_all()` and
calling `browseVignettes(pkgname)` or `vignette(vignName)` and the devel
vignettes are found. The `doc` and `Meta` directories are added to
.Rbuildignore; so they will not be included in the built package.

Fixes #1703
Fixes #1809
jimhester added a commit that referenced this issue Jul 20, 2018
@jimhester
Use better vignette workflow
2e9f5b7 
This installs the built vignettes to doc/ rather than inst/doc and
builds a vignette index in Meta/vignette.rds. This means that you can
view development vignettes by loading the package with `load_all()` and
calling `browseVignettes(pkgname)` or `vignette(vignName)` and the devel
vignettes are found. The `doc` and `Meta` directories are added to
.Rbuildignore; so they will not be included in the built package.

Fixes #1703
Fixes #1809
jimhester added a commit that referenced this issue Jul 27, 2018
@jimhester
Use better vignette workflow
a36adf4 
This installs the built vignettes to doc/ rather than inst/doc and
builds a vignette index in Meta/vignette.rds. This means that you can
view development vignettes by loading the package with `load_all()` and
calling `browseVignettes(pkgname)` or `vignette(vignName)` and the devel
vignettes are found. The `doc` and `Meta` directories are added to
.Rbuildignore; so they will not be included in the built package.

Fixes #1703
Fixes #1809
@lock
Copy link

lock bot commented Jan 23, 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 Jan 23, 2019
HughParsonage pushed a commit to HughParsonage/devtools that referenced this issue Jul 2, 2019
@jimhester @HughParsonage
Use better vignette workflow
7af930f 
This installs the built vignettes to doc/ rather than inst/doc and
builds a vignette index in Meta/vignette.rds. This means that you can
view development vignettes by loading the package with `load_all()` and
calling `browseVignettes(pkgname)` or `vignette(vignName)` and the devel
vignettes are found. The `doc` and `Meta` directories are added to
.Rbuildignore; so they will not be included in the built package.

Fixes r-lib#1703
Fixes r-lib#1809
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
feature a feature request or enhancement vignettes 📜
Projects
None yet
Milestone
2.0.0
Development

No branches or pull requests
2 participants
@jimhester @wolski