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.

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

Feature request: a reference topic holding all exported objects #2777

Open
mmuurr opened this issue Sep 12, 2024 · 0 comments
Open

Feature request: a reference topic holding all exported objects #2777

mmuurr opened this issue Sep 12, 2024 · 0 comments

Comments

@mmuurr
Copy link

mmuurr commented Sep 12, 2024

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 😆.

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

No branches or pull requests

2 participants