`autodoc_class_signature = "separated"` cause a warning for enum with no `__init__` about sphinx HOT 12 OPEN

Your repo doesn't have any Python class and no Enum as said in the title. This bug report is missing a minimal reproducer.

from sphinx.

Your repo doesn't have any Python class and no Enum as said in the title. This bug report is missing a minimal reproducer.

Which repo are you talking about?

https://github.com/trim21/sphinx-autodoc_class_signature-bug/blob/ee160815ed1c6217e1e4b9751c7d362453ee4c8a/lib/__init__.py#L4

lib/__init__.py

import enum


class Status(str, enum.Enum):
    """enum for status"""

from sphinx.

I can confirm the bug but I'm not sure if it's a bug because of the .. autoclass directive or not... Without the directive and by using :members: for .. automodule, the enumeration is being shown normally but using autoclass on the enumeration, it appears that there is an issue...

I can try to fix it but I don't like specializing the behaviours for enums in general because it's an API that is constantly changing... I'll try to see what I can do.

from sphinx.

interesting, now I can't re-produce this...

from sphinx.

OK, I'm guessing this only happed on old version of python. I can reproduce this with py 3.9 but not 3.12

from sphinx.

Oh yes, I was using the same version as you (3.10) and could confirm the bug. That's why I said I hate working with the enum API since it changes every version...

from sphinx.

I more generic way could be make :exclude-members: __init__ work? I guess?

I don't know how sphinx works internally...

from sphinx.

Normal class with __new__ only doesn't have this problem...

from sphinx.

The exclude-members wouldn't work because we are always picking all members before excluding them later. The rationale is because the filtering logic can be changed by the user after. The flow is more or less:

• Pick everything.
• Filter when needed.
• Ask extensions if this should really be filtered.
• Do your things.

However, the warnings happens before the exclusion is being made (it's trying to pick up every possible members).

from sphinx.

thanks for your answer.

from sphinx.

I've found the issue:

It appears we are forcibly assuming that __new__ and __init__ exist, which may not necessarily be the case and you get the warning here:

So, I should add some if-logic for this warning if the __new__ and __init__ are missing but I won't have much time today.

from sphinx.

I currently just use workaround with adding :members:

from sphinx.