Skip to content

Alias Expands Nested Class Documentation #69

@deckar01

Description

@deckar01

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions