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

Conceal 'private' methods from documentation #816

Open
salvadord opened this issue May 1, 2024 · 0 comments
Open

Conceal 'private' methods from documentation #816

salvadord opened this issue May 1, 2024 · 0 comments

Comments

@salvadord
Copy link
Collaborator

Now "package reference" section lists all the methods/functions across the codebase. But many of them are intended to be private. I suppose sphinx (lib that autogenerates the docs) should have such option to exclude a given method, otherwise, we can try prefixing the private ones with double-underscore.
The ultimate goal is to make only those methods to be discoverable through docs, which are intended to be exposed to the users

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

1 participant