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

autodoc: autoattribute directive can't create document for commented attribute in alias class #8534

Closed
tk0miya opened this issue Dec 13, 2020 · 0 comments

Comments

@tk0miya
Copy link
Member

tk0miya commented Dec 13, 2020

Describe the bug
autodoc: autoattribute directive can't create document for commented attribute in alias class

To Reproduce

# example.py

class Foo:
    def __init__(self):
        self.attr = None  #: docstring

Alias = Foo
# index.rst

.. autoattribute:: example.Alias.attr

This example causes ImportError on generating a document.

Expected behavior
Build successfully.

Your project
No

Screenshots
No

Environment info

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

Additional context
No

@tk0miya tk0miya added this to the 3.4.0 milestone Dec 13, 2020
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 15, 2020
tk0miya added a commit that referenced this issue Dec 16, 2020
Fix #8534: autoattribute failed to document a commented attribute in alias class
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 16, 2020
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 16, 2020
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 16, 2020
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 17, 2020
tk0miya added a commit that referenced this issue Dec 17, 2020
Fix #8534: autoattribute failed to document a commented attribute in alias dervied class
@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.
Projects
None yet
Development

No branches or pull requests

1 participant