Skip to content

How to include private class and inherited functions in the docs? #540

Closed Answered by pawamoy
leowu4ever asked this question in Q&A
Discussion options

You must be logged in to vote

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:

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          filters: []

Or locally:

::: some.object
    options:
      filters: []

You can also try to use the members option, which allows you to explicitely list the direct members that should be included.

Replies: 1 comment 1 reply

Comment options

You must be logged in to vote
1 reply
@pawamoy
Comment options

Answer selected by pawamoy
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
Q&A
Labels
None yet
2 participants