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

Alias Expands Nested Class Documentation #69

Closed
deckar01 opened this issue Feb 26, 2022 · 1 comment · Fixed by #101
Closed

Alias Expands Nested Class Documentation #69

deckar01 opened this issue Feb 26, 2022 · 1 comment · Fixed by #101

Comments

@deckar01
Copy link

Assigning a type to a class attribute is documented as an alias, but its nested class members are being expanded.

class NestedClass:
    """Parent class"""
    class Foo:
        """Nested class"""
        def foo(self):
            """Nested method"""
            pass

        def bar(self):
            """Nested method"""
            pass

class Attribute:
    """Attribute"""
    #: Alias
    foo = NestedClass.Foo
    #: Attribute
    bar = 'bar'

Screen Shot 2022-02-25 at 6 30 14 PM

Without autosummary on auto doc does not recurse on aliases:

Screen Shot 2022-02-25 at 6 28 57 PM

@Chilipp
Copy link
Owner

Chilipp commented Feb 28, 2022

thanks for reporting @deckar01! I do have no idea so far what causes this behaviour

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants