IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add new event: autodoc-before-process-signature

Browse Source
This commit is contained in:
Takeshi KOMIYA
2020-01-13 13:16:59 +09:00
parent 729ffa1fcd
commit 74a5f350a1
3 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/usage/extensions/autodoc.rst
View File

@@ -494,6 +494,17 @@ autodoc provides the following additional events:
auto directive
:param lines: the lines of the docstring, see above
.. event:: autodoc-before-process-signature (app, obj, bound_method)
.. versionadded:: 2.4
Emitted before autodoc formats a signature for an object. The event handler
can modify an object to change its signature.
:param app: the Sphinx application object
:param obj: the object itself
:param bound_method: a boolean indicates an object is bound method or not
.. event:: autodoc-process-signature (app, what, name, obj, options, signature, return_annotation)
.. versionadded:: 0.5