How to include private class and inherited functions in the docs? #540
-
Hi, can anyone guide me how to include private class and inherited functions in docs. Thank you |
Beta Was this translation helpful? Give feedback.
Answered by
pawamoy
Mar 24, 2023
Replies: 1 comment 1 reply
-
Hello! Inherited members are only supported by the legacy handler for now. I'm working on bringing support in the new handler. Globally: plugins:
- mkdocstrings:
handlers:
python:
options:
filters: [] Or locally: ::: some.object
options:
filters: [] You can also try to use the |
Beta Was this translation helpful? Give feedback.
1 reply
Answer selected by
pawamoy
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hello! Inherited members are only supported by the legacy handler for now. I'm working on bringing support in the new handler.
Private members can be included by resetting or changing default
filters
.Globally:
Or locally:
You can also try to use the
members
option, which allows you to explicitely list the direct members that should be included.