Listing enumerations in the generated docs #633
-
If my module contains: import enum
class MyEnum(enum.Enum):
A = 0
B = 1
C = 2 The generated docs only list Thanks |
Beta Was this translation helpful? Give feedback.
Answered by
pawamoy
Nov 23, 2023
Replies: 1 comment 1 reply
-
Each value is an attribute of the class, so you can either document them, or set class MyEnum(enum.Enum):
"""Docs for the class."""
A = 0
"""Docs for A."""
B = 1
"""Docs for B."""
C = 2
"""Docs for C.""" |
Beta Was this translation helpful? Give feedback.
1 reply
Answer selected by
pawamoy
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Each value is an attribute of the class, so you can either document them, or set
show_if_no_docstring: true
for the class.