Docstring at multilevel inheritance #125

jannifri · 2024-01-17T10:27:25Z

jannifri
Jan 17, 2024

Hello,
I have a question/problem:

When I have a multilevel inheritance architecture, is there a way to show the docstring of the “base”-class?
Currently, it seems that only the docstring of the inherited class of the first level will be considered.

Here is an example (example.py):

from abc import ABC

class MyIface(ABC):
    """This is my iface."""

    def __init__(self):
        """Init MyIface."""
        pass

    def func(self):
        """This is docstring of func_iface."""
        pass

class A(MyIface):
    """This is A."""

    def __init__(self):
        """Init Base."""
        pass

    def func(self):
        pass

    def func_A(self):
        """This is docstring of func_A."""
        pass

class B(A):
    """This is B."""

    def __init__(self):
        """Init Base."""
        pass

I want to render the docs of “class B”

In markdown file:
::: example.B

settings in .yml-file:

- mkdocstrings:
    handlers:
      python:
        paths: [src]
        options:
          docstring_style: google
          docstring_section_style: table
          docstring_options:
            ignore_init_summary: true
          merge_init_into_class: true
          show_if_no_docstring: true
          show_docstring_description: True
          show_bases: False
          show_source: False
          show_root_toc_entry: false
          inherited_members: true
          heading_level: 3

Result: