Hide private methods in API reference (MkDocs)

deel-ai / oodeel

Simple, compact, and hackable post-hoc deep OOD detection for already trained tensorflow or pytorch image classifiers.

https://deel-ai.github.io/oodeel/

MIT License

51 stars 2 forks source link

Hide private methods in API reference (MkDocs) #79

Open y-prudent opened 11 months ago

y-prudent commented 11 months ago

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 commented 11 months ago

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.