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

Hide private methods in API reference (MkDocs) #79

Open
y-prudent opened this issue Oct 26, 2023 · 1 comment
Open

Hide private methods in API reference (MkDocs) #79

y-prudent opened this issue Oct 26, 2023 · 1 comment

Comments

@y-prudent
Copy link
Member

In https://deel-ai.github.io/oodeel/api/methods/ for instance, the API is a bit messy and hard to read because of methods like _deviation or _stats which are useless for the user. Is it possible to filter the doc content we want to show?

@cofri
Copy link
Contributor

cofri commented Oct 26, 2023

I think private methods can be removed from generated API by updating filters parameter in docs/api/methods.md. The default value for filters (see here) does not display private functions.

By the way, the default Python handler in mkdocstrings was recently changed and new options are available for a better rendering of the API documentation. We might work on it.

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

No branches or pull requests

2 participants