Hide one function from the class

[PerchunPak]

So I have a class, which implements an internal to_json. I also have a function, that takes an object and calls its to_json. I would like to not show to the user this to_json on the auto-generated class documentation, how could I achieve that?

class Example:
    def to_json(self):  # I want to hide this from docs
        ...

class ToJsonImplemented(typing.Protocol):
    def to_json(self) -> dict: ...

def obj_to_json(obj: ToJsonImplemented) -> dict: ...

There are multiple classes that implement to_json method, so it made sense to create obj_to_json as it does some additional logic (that would be necessary to do in every to_json otherwise). But this is pretty-much internal thing, and I don't want to show it to user. Docs are generated like this:

::: src.some.Example

[pawamoy]

You can use the filters or members options, I'll let you check the details in our docs 🙂

[PerchunPak]

Oh, you are right! Sorry for rockie question

::: src.some.Example
    options:
      filters:
      - "!to_json"

[pawamoy]

No worries, thanks for confirming it works for you!