-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Description
I have implemented a custom roxygen2 roclet (roxytest), and I have a project with a package using it, meaning that my DESCRIPTION contains this:
Roxygen: list(roclets = c("namespace", "rd", "roxytest::testthat_roclet"))
In Rstudio under Project Options under Build Tools I have enabled "Generate documentation with roxygen" and under Configure I can choose the four different roxygen2 roclets (rd, namespace, collate, vignette) and then when to do it.
When I then trigger the Document Package (e.g. by Ctrl+Shift+D/Cmd+Shift+D) then
devtools::document(roclets = c('rd', 'collate', 'namespace'))
is executed. Without the roxytest::testtthat_roclet specified in the DESCRIPTION file. That means that to use the custom roxytest::testtthat_roclet I need to manually execute
roxygen2::roxygenise()
My feature request is to somehow trigger (e.g. by Ctrl+Shift+D/Cmd+Shift+D) devtools::document() without specifying the roclets argument.
This would make it more user-friendly to use custom roclets.
One way is to uncheck all roclets. But currently, then nothings happens when pressing Ctrl+Shift+D/Cmd+Shift+D.
Another way is that under Project Options -> Build Tools -> Configure (next to "Generate documentation with roxygen") add an option "Use specification in DESCRIPTION file" (and then the four default roxygen2 roclets cannot be chosen) -- or something like that.