Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

autosummary does not show info for instance attributes #3257

Closed
daphtdazz opened this issue Dec 17, 2016 · 2 comments
Closed

autosummary does not show info for instance attributes #3257

daphtdazz opened this issue Dec 17, 2016 · 2 comments
Labels
extensions:autosummary type:enhancement enhance or introduce a new feature

Comments

@daphtdazz
Copy link

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
@shimizukawa shimizukawa added extensions:autodoc type:enhancement enhance or introduce a new feature labels Dec 17, 2016
@shimizukawa
Copy link
Member

Memo: documenting class instance attribute is not implemented in current Sphinx (1.5.1).

@leotrs
Copy link

leotrs commented Aug 25, 2020

This still seems to be the case. I'd love to see it be implemented!

@tk0miya tk0miya closed this as completed May 5, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
extensions:autosummary type:enhancement enhance or introduce a new feature
Projects
None yet
Development

No branches or pull requests

4 participants