Support PEP 702 to register deprecations with autdoc #12334
saulshanabrook
started this conversation in
Feature requests and ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Is your feature request related to a problem? Please describe.
I am currently using PEP 702 to mark functions and classes as deprecated in Python, like this:
However, that information does not show up in sphinx when I autodoc the functions/classes, so users are not aware that they are from looking at the docs.
Describe the solution you'd like
It would be great if the
deprecated
directive would be added to classes, functions, and overloaded functions that are tagged with this decorator.Describe alternatives you've considered
Instead, for now I can manually add that to the docstring as well.
Additional context
Beta Was this translation helpful? Give feedback.
All reactions