add documentation for availability and differences for autodoc-process-docstring
(and some friends)
#468
Labels
autodoc-process-docstring
(and some friends)
#468
Hi,
I am in need for some module docstring post-processing, and it took me rather long to figure out that:
autoapi
also allows (some?)autodoc-*
events to be capturedwhat
Especially it took me quite a while to figure out there are some subtle differences:
what
can be :"module", "class", "exception", "function", "method", "attribute"
what
can be :"package", "class", "exception", "function", "method", "attribute", "data"
Im not quite sure if t
I think that would be good to add to the documentation if this is indeed the intent, rather than a side effect of something else in my setup
It appears that the
autodoc-process-signature
event is also available, but I have not done any further validation on that, but as it appears to be used internally byautoapi
, it is likely to work as well.The text was updated successfully, but these errors were encountered: