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.

Sign up for GitHub

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

Jump to bottom

autoattribute could not create document for a GenericAliase as class attributes correctly #8503

Closed
tk0miya opened this issue Nov 28, 2020 · 0 comments
Closed

autoattribute could not create document for a GenericAliase as class attributes correctly #8503

tk0miya opened this issue Nov 28, 2020 · 0 comments
Labels
extensions:autodoc type:bug
Milestone
3.4.0

Comments

@tk0miya
Copy link
Member

tk0miya commented Nov 28, 2020

Describe the bug
autoattribute could not create document for a GenericAliase as class attributes correctly

To Reproduce

# example.py
class Foo:
    attr = List[int]

# index.rst
.. autoattribute:: example.Foo.attr

The build succeeded. But docstring is not shown.

Expected behavior

Document should be generated successfully like when I used automodule.

Your project
N/A

Screenshots
N/A

Environment info

  • OS: Mac
  • Python version: 3.9.0
  • Sphinx version: HEAD of 3.x
  • Sphinx extensions: sphinx.ext.autodoc
  • Extra tools: Nothing

Additional context
Nothing
@tk0miya tk0miya added this to the 3.4.0 milestone Nov 28, 2020
tk0miya added a commit to tk0miya/sphinx that referenced this issue Nov 28, 2020
@tk0miya
Fix sphinx-doc#8503: autoattribute could not create document for a Ge…
265fa01 
…nericAlias
tk0miya added a commit to tk0miya/sphinx that referenced this issue Nov 28, 2020
@tk0miya
Fix sphinx-doc#8503: autoattribute could not create document for a Ge…
83d4b59 
…nericAlias
@tk0miya tk0miya mentioned this issue Nov 28, 2020
Merged
tk0miya added a commit to tk0miya/sphinx that referenced this issue Nov 28, 2020
@tk0miya
Fix sphinx-doc#8503: autoattribute could not create document for a Ge…
24296b9 
…nericAlias
tk0miya added a commit to tk0miya/sphinx that referenced this issue Nov 29, 2020
@tk0miya
Fix sphinx-doc#8503: autoattribute could not create document for a Ge…
feb9a24 
…nericAlias
tk0miya added a commit to tk0miya/sphinx that referenced this issue Nov 29, 2020
@tk0miya
Fix sphinx-doc#8503: autoattribute could not create document for a Ge…
31cbf0f 
…nericAlias
tk0miya added a commit that referenced this issue Nov 29, 2020
@tk0miya
Merge pull request #8504 from tk0miya/deprecate_GenericAliasDocumenter
aa84eea 
Fix #8503: autoattribute could not create document for a GenericAlias
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
extensions:autodoc type:bug
Projects
None yet
Milestone
3.4.0
Development

No branches or pull requests
1 participant
@tk0miya