diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-01-30 23:25:42 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-30 23:25:42 +0900 |
| commit | 0f8a868bf738342194d07f2edcc866001590fd63 (patch) | |
| tree | 69c7e4609b4abd2702dda80dcd8567b21954bcb4 /doc/extdev | |
| parent | 0cc625a82c029d59a443f17df9fa31eaf83bf336 (diff) | |
| parent | 67fefcc6f965c99b26683782a86cbdce936cd19f (diff) | |
| download | sphinx-git-0f8a868bf738342194d07f2edcc866001590fd63.tar.gz | |
Merge pull request #7018 from tk0miya/6418_autodoc_typehints_description
6418 autodoc typehints description
Diffstat (limited to 'doc/extdev')
| -rw-r--r-- | doc/extdev/appapi.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst index 7a8ffef10..e89da7ce9 100644 --- a/doc/extdev/appapi.rst +++ b/doc/extdev/appapi.rst @@ -218,6 +218,14 @@ connect handlers to the events. Example: .. versionadded:: 0.5 +.. event:: object-description-transform (app, domain, objtype, contentnode) + + Emitted when an object description directive has run. The *domain* and + *objtype* arguments are strings indicating object description of the object. + And *contentnode* is a content for the object. It can be modified in-place. + + .. versionadded:: 2.4 + .. event:: doctree-read (app, doctree) Emitted when a doctree has been parsed and read by the environment, and is |