Chilipp / autodocsumm

Extending your autodoc API docs with a summary
Apache License 2.0
48 stars 14 forks source link

Alias Expands Nested Class Documentation #69

Open deckar01 opened 2 years ago

deckar01 commented 2 years ago

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 commented 2 years ago

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