How to handle multiple inheritence/mixins?

[stumpylog]

Given something like this, how can I document the final class and its members?

class MixinA:
    def do_thing_a(self):
      pass

class MixinB:
    def do_thing_b(self):
      pass

class ChildAB(MixinA, MixinB):
    pass

I'm writing the Markdown as:

::: package.ChildAB
    handler: python
    options:
      members:
        - do_thing_a
        - do_thing_b

Adding force_inspection results in the module not being found. So far I haven't found how I can document just the child class, but with those mixin methods.

[pawamoy]

Try setting inherited_members: true 🙂 See https://mkdocstrings.github.io/python/usage/configuration/members/#inherited_members

[stumpylog]

That seems to have no effect. Is there a way to set a depth for inheritance? The actual classes I'm working with are more involved, something like:

class BaseRouteMixin(MixinA, MixinB):
  pass
class SyncRoute(BaseRouteMixin, SyncBaseRoute):
  pass
class AsyncRoute(BaseRouteMixin, AsyncBaseRoute):
  pass

Though base route may have a dozen mixins for all its common options.

In more concrete terms, I'm trying to document a class like https://github.com/stumpylog/gotenberg-client/blob/b76647f4721397214dfc6430dc045ad56a49f44d/src/gotenberg_client/_libreoffice/routes.py#L79, which ends up about 3 levels deep after sync vs async.

[stumpylog]

And doing MixinX individually doesn't fit the use case, they're purely internal, the user facing interface is the Route

[pawamoy]

This should be supported. I'll investigate in your public repo.

[pawamoy]

• Your options are not correctly indented (formatted by prettier?): https://raw.githubusercontent.com/stumpylog/gotenberg-client/refs/heads/chore/autodocs/docs/reference.md

• Set paths in mkdocs.yml and remove src. from ::: instructions

  plugins:
    - mkdocstrings:
        handlers:
          python:
            paths: [src]

• Do not escape underscores after :::

• Adding inherited_members: true works

Result:

::: gotenberg_client._chromium.routes.SyncUrlToPdfRoute
    handler: python
    options:
        inherited_members: true
        members:
        - fail_on_console_exception
        - fail_on_exceptions
        - dont_fail_on_exceptions

[stumpylog]

Yep, that works, thank you. It seems like I'll have to fight prettier over this.