Skip to content

Commit cb455dd

Browse files
Add per-event overloads to Sphinx.connect() (#12784)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
1 parent 76ead87 commit cb455dd

File tree

4 files changed

+350
-17
lines changed

4 files changed

+350
-17
lines changed

doc/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,19 +186,24 @@
186186
('js:func', 'number'),
187187
('js:func', 'string'),
188188
('py:attr', 'srcline'),
189+
('py:class', '_ConfigRebuild'), # sphinx.application.Sphinx.add_config_value
189190
('py:class', '_StrPath'), # sphinx.environment.BuildEnvironment.doc2path
190191
('py:class', 'Element'), # sphinx.domains.Domain
191192
('py:class', 'Documenter'), # sphinx.application.Sphinx.add_autodocumenter
192193
('py:class', 'IndexEntry'), # sphinx.domains.IndexEntry
194+
('py:class', 'Lexer'), # sphinx.application.Sphinx.add_lexer
193195
('py:class', 'Node'), # sphinx.domains.Domain
194196
('py:class', 'NullTranslations'), # gettext.NullTranslations
197+
('py:class', 'Path'), # sphinx.application.Sphinx.connect
195198
('py:class', 'RoleFunction'), # sphinx.domains.Domain
196199
('py:class', 'RSTState'), # sphinx.utils.parsing.nested_parse_to_nodes
197200
('py:class', 'Theme'), # sphinx.application.TemplateBridge
198201
('py:class', 'SearchLanguage'), # sphinx.application.Sphinx.add_search_language
199202
('py:class', 'StringList'), # sphinx.utils.parsing.nested_parse_to_nodes
200203
('py:class', 'system_message'), # sphinx.utils.docutils.SphinxDirective
201204
('py:class', 'TitleGetter'), # sphinx.domains.Domain
205+
('py:class', 'todo_node'), # sphinx.application.Sphinx.connect
206+
('py:class', 'Transform'), # sphinx.application.Sphinx.add_transform
202207
('py:class', 'XRefRole'), # sphinx.domains.Domain
203208
('py:class', 'docutils.nodes.Element'),
204209
('py:class', 'docutils.nodes.Node'),
@@ -210,6 +215,7 @@
210215
('py:class', 'docutils.parsers.rst.states.Inliner'),
211216
('py:class', 'docutils.transforms.Transform'),
212217
('py:class', 'nodes.NodeVisitor'),
218+
('py:class', 'nodes.TextElement'), # sphinx.application.Sphinx.connect
213219
('py:class', 'nodes.document'),
214220
('py:class', 'nodes.reference'),
215221
('py:class', 'pygments.lexer.Lexer'),

doc/extdev/event_callbacks.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,10 @@ Here is a more detailed list of these events.
107107

108108
:param app: :class:`.Sphinx`
109109
:param env: :class:`.BuildEnvironment`
110-
:param added: ``set[str]``
111-
:param changed: ``set[str]``
112-
:param removed: ``set[str]``
113-
:returns: ``list[str]`` of additional docnames to re-read
110+
:param added: ``Set[str]``
111+
:param changed: ``Set[str]``
112+
:param removed: ``Set[str]``
113+
:returns: ``Sequence[str]`` of additional docnames to re-read
114114

115115
Emitted when the environment determines which source files have changed and
116116
should be re-read.

0 commit comments

Comments
 (0)