You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
While developing one's own package, or inheriting someone else's (which is somewhat common in my work environment), it would be helpful to be able to generate a reference page with simply all exported objects (and for functions, including their signatures).
This can already be done a few ways by adding tags to each such object and/or using the {pkgdown} selectors, like starts_with().
But in the desire to simultaneously add documentation while also using & improving such packages, it would be very helpful to generate a reference page/section that simply lists all exported objects (say, as determined by the NAMESPACE file).
I've come up with a few ways to try to do this in an automated fashion (e.g. by reading NAMESPACE and dynamically editing the _pkdown.yml file) but they all feel very much like hacks, and I'm surprised something simple doesn't already exist with {pkgdown} and {roxygen2}, as many other languages/ecosystems have some mechanism in place to simply provide a web-based digest of 'public' (and sometimes 'private') objects.
The ideal solution would require only the most minimal {roxygen2} namespace-management tags (specifically, @export), not any specific documentation tag -- as in the inheriting-someone-else's-code case this means reading the code in order to generate a tool that helps one ... read the code 😆.
The text was updated successfully, but these errors were encountered:
While developing one's own package, or inheriting someone else's (which is somewhat common in my work environment), it would be helpful to be able to generate a reference page with simply all exported objects (and for functions, including their signatures).
This can already be done a few ways by adding tags to each such object and/or using the {pkgdown} selectors, like
starts_with()
.But in the desire to simultaneously add documentation while also using & improving such packages, it would be very helpful to generate a reference page/section that simply lists all exported objects (say, as determined by the
NAMESPACE
file).I've come up with a few ways to try to do this in an automated fashion (e.g. by reading NAMESPACE and dynamically editing the
_pkdown.yml
file) but they all feel very much like hacks, and I'm surprised something simple doesn't already exist with {pkgdown} and {roxygen2}, as many other languages/ecosystems have some mechanism in place to simply provide a web-based digest of 'public' (and sometimes 'private') objects.The ideal solution would require only the most minimal {roxygen2} namespace-management tags (specifically,
@export
), not any specific documentation tag -- as in the inheriting-someone-else's-code case this means reading the code in order to generate a tool that helps one ... read the code 😆.The text was updated successfully, but these errors were encountered: