Skip to content

autosummary does not show info for instance attributes #3257

@daphtdazz

Description

@daphtdazz

Subject: autosummary does not show info for instance attributes

Problem

Autosummary finds instance attributes and puts them in the table, but it does not find an annotation that went with them and put the first line of that in the table

Initially came from a stack overflow question.

Procedure to reproduce the problem

Have some code like:

test.py
class MyClass:
    def __init__(self):
        self.attribute = "An Attribute"
        """This is a cool attribute."""
test.rst
.. autosummary::
    test.MyClass.attribute

Error logs / results

test.MyClass.attribute

Expected results

test.MyClass.attribute This is a cool attribute.

Or something.

Reproducible project / your project

As per the "Procedure to reproduce the problem".

Environment info

  • OS: Linux/Mac (but I expect all of them)
  • Python version: 3.5.0
  • Sphinx version: 1.3.1

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions