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

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

Closed
wolski opened this Issue Jul 3, 2018 · 1 comment

Comments

Projects
None yet
2 participants
@wolski

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

This comment has been minimized.

Member

jimhester commented Jul 5, 2018

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

@jimhester jimhester added the feature 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

Use better vignette workflow
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

Use better vignette workflow
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

Use better vignette workflow
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 jimhester closed this in 57b6958 Jul 27, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment