We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
sphinx-autodoc supports the use of #: comments to document class attributes (ref). It would be great to have the same support in enum_tools
#:
enum_tools
e.g.
class MyEnum(Enum): #: This is an A value A = auto() #: This is another value B = auto()
The text was updated successfully, but these errors were encountered:
It is already implemented as long as you use the decorator document_enum, see https://enum-tools.readthedocs.io/en/latest/api/documentation.html#enum_tools.documentation.document_enum.
This, however, adds this library as a runtime dependency to your project. That is not beautiful but currently up to my knowledge not avoidable.
Sorry, something went wrong.
domdfcoding
No branches or pull requests
Description
sphinx-autodoc supports the use of
#:
comments to document class attributes (ref). It would be great to have the same support inenum_tools
e.g.
Version
Other Additional Information:
The text was updated successfully, but these errors were encountered: