Instance variable not shown correctly

[maeddlae]

Description Instance variable is not shown correctly:

Example

class Example():
    """
    class documentation
    """
    class_variable = 12 #: This is a classvariable

    def __init__(self):
        """
        constructor doc
        """
        self.instance_variable = 34 #: This is an instance variable

Generated output:

Setup:

• Python 3.7.1
• Sphinx 2.0.1
• autodocsumm 0.1.9
• sphinx-rtd-theme 0.4.3

[Chilipp]

Good point, yes, that is at the moment not working. The only workaround is to create a class_variable and override it in the corresponding instance

class Example():
    """
    class documentation
    """
    class_variable = 12 #: This is a classvariable

    instance_variable = None #: This is an instance variable and will be overwritten

    def __init__(self):
        """
        constructor doc
        """
        self.instance_variable = 34 #: This is an instance variable

But you are right, since autodoc is able to put the instance_variable here, autodocsumm should as well

[maeddlae]

Do you plan to fix this in the near future? I am asking because autodocsumm perfectly fits my needs. But showing the attributes is critical for me..

[Chilipp]

Yes, I will work on it before Sunday. I don't think it should be too difficult.

[maeddlae]

Great, thanks a lot. Then I will wait for your update:-)