autodoc inherited-members won't work for inherited attributes (data members).

[shimizukawa]

autodoc searches for a cached docstring using (namespace, attrname) as search-key, but doesn't check for baseclass-namespace.

---

• Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/741
• Originally reported by: Anonymous
• Originally created at: 2011-08-02T17:05:58.754

[shimizukawa]

From mitar on 2012-01-07 18:21:47+00:00

Also {{{find_attr_doc}}} seems to not find inherited attributes?

[shimizukawa]

From mitar on 2012-01-07 20:04:22+00:00

The problem is also that parser for attributes' doc strings parses only one module. It should also parses modules of all parent classes and combine everything.

[shimizukawa]

From Jon Waltman on 2012-11-30 15:14:18+00:00

Issue #1048 was marked as a duplicate of this issue.

[halfak]

I'm currently getting bit by this issue in 1.2.3. #2233 is preventing me from working with 1.3.x. Is there a workaround you might recommend?

[LevN0]

Is there any hope of getting this fixed, or a workaround? As mentioned in #1048 even using autoattribute does not work.

[numberoverzero]

I'm also running into this. For now I'm manually duplicating docstrings, but it would be nice if :inherited-members: worked.

I'm not familiar with the code base at all, but if anyone's willing to point me in a direction I can try to write a fix.

[MatthieuPERIN]

Any news on this feature / bugfix ?

[hagenw]

I saw that #8548 was merged and released inside sphinx 3.4.0.

But a simple :inherited-members: does still not include attributes, e.g.

class A(object):

    def __init__(self):
        self.a = a
        r"""My first attribute."""

class B(A):

    def __init__(self):
        self.b = b
        r"""My second attribute."""

.. automodule:: abtest

.. autoclass:: B
    :members:
    :inherited-members:

[tk0miya]

@hagenw Thank you for letting me know. Indeed, this option is only working on test script. I submit a fix for this again: #8587.