-
Notifications
You must be signed in to change notification settings - Fork 33
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
building a package deletes inst/doc #128
Comments
The rcmdcheck package already uses switch in |
That would be great. I assume that it would be honoured by |
FYI I mentioned the prospect of this in the vignettes chapter of R Packages like so:
The general stance in devtools and the book is to not keep anything in |
Doesn't an option to prevent wiping off Not a big deal here but similar stance on pdf's by pkgdown (which ignores them) and the GHA check workflows are really painful (the latter don't include LaTeX examples and the incorporation in a workflow of the separately provided examples is tricky and changes as the GHA evolve). |
I don't think it is very important to wipe out OTOH, it is easy to package up outdated files on your local computer when you are submitting a package, so cleaning In any case, when we implement support for We'll think about whether the default could be different on the CI. |
Now `pkgbuild::build()` will not clean up `inst/doc` by default if the `Config/build/clean-inst-doc` entry in `DESCRIPTION` is set to `FALSE`. Closes #128.
I know that this was raised in #58 but there the discussion was about specific user cases.
devtools::check()
also usespkgbuild
to build a package and thus deletesinst/doc
, as well.The fact is that
inst/doc
is not designated for automatically generated files only. In that sense, deleting it is analogous to the former roxygen2 approach to overwrite, for example, NAMESPACE (which it does not do any more).WRE, section 1.4, explicitly provides for the possibility to have other files and subdirectories in
inst/doc
:A compromise would be to delete files in
inst/doc
except forinst/doc/index.html
and not touch subdirectories ofinst/doc
.The text was updated successfully, but these errors were encountered: