@@ -94,7 +94,7 @@ Here is a more detailed list of these events.
94
94
95
95
Emitted when the config object has been initialized.
96
96
97
- .. versionadded :: 1.8
97
+ .. version-added :: 1.8
98
98
99
99
.. event :: builder-inited (app)
100
100
@@ -118,7 +118,7 @@ Here is a more detailed list of these events.
118
118
that the environment has determined.
119
119
You can return a list of docnames to re-read in addition to these.
120
120
121
- .. versionadded :: 1.1
121
+ .. version-added :: 1.1
122
122
123
123
.. event :: env-purge-doc (app, env, docname)
124
124
@@ -135,7 +135,7 @@ Here is a more detailed list of these events.
135
135
When a source file has been changed, the cache's entries for the file are cleared,
136
136
since the module declarations could have been removed from the file.
137
137
138
- .. versionadded :: 0.5
138
+ .. version-added :: 0.5
139
139
140
140
.. event :: env-before-read-docs (app, env, docnames)
141
141
@@ -153,7 +153,7 @@ Here is a more detailed list of these events.
153
153
You can also remove document names; do this with caution since it will make
154
154
Sphinx treat changed files as unchanged.
155
155
156
- .. versionadded :: 1.3
156
+ .. version-added :: 1.3
157
157
158
158
.. event :: source-read (app, docname, content)
159
159
@@ -172,7 +172,7 @@ Here is a more detailed list of these events.
172
172
LaTeX, you can use a regular expression to replace ``$...$ `` by
173
173
``:math:`...` ``.
174
174
175
- .. versionadded :: 0.5
175
+ .. version-added :: 0.5
176
176
177
177
.. event :: include-read (app, relative_path, parent_docname, content)
178
178
@@ -192,7 +192,7 @@ Here is a more detailed list of these events.
192
192
You can process the ``content `` and replace this item
193
193
to transform the included content, as with the :event: `source-read ` event.
194
194
195
- .. versionadded :: 7.2.5
195
+ .. version-added :: 7.2.5
196
196
197
197
.. seealso :: The :dudir:`include` directive and the :event:`source-read` event.
198
198
@@ -207,7 +207,7 @@ Here is a more detailed list of these events.
207
207
*objtype * arguments are strings indicating object description of the object.
208
208
And *contentnode * is a content for the object. It can be modified in-place.
209
209
210
- .. versionadded :: 2.4
210
+ .. version-added :: 2.4
211
211
212
212
.. event :: doctree-read (app, doctree)
213
213
@@ -240,7 +240,7 @@ Here is a more detailed list of these events.
240
240
or raise :class: `~sphinx.errors.NoUri ` to prevent other handlers in
241
241
trying and suppress a warning about this cross-reference being unresolved.
242
242
243
- .. versionadded :: 0.5
243
+ .. version-added :: 0.5
244
244
245
245
.. event :: warn-missing-reference (app, domain, node)
246
246
@@ -257,7 +257,7 @@ Here is a more detailed list of these events.
257
257
:confval: `nitpick_ignore ` and :confval: `nitpick_ignore_regex `
258
258
prevent the event from being emitted for the corresponding nodes.
259
259
260
- .. versionadded :: 3.4
260
+ .. version-added :: 3.4
261
261
262
262
.. event :: doctree-resolved (app, doctree, docname)
263
263
@@ -290,7 +290,7 @@ Here is a more detailed list of these events.
290
290
environment from the main process. *docnames * is a set of document names
291
291
that have been read in the subprocess.
292
292
293
- .. versionadded :: 1.3
293
+ .. version-added :: 1.3
294
294
295
295
.. event :: env-updated (app, env)
296
296
@@ -305,9 +305,9 @@ Here is a more detailed list of these events.
305
305
will then be considered updated, and will be (re-)written during the writing
306
306
phase.
307
307
308
- .. versionadded :: 0.5
308
+ .. version-added :: 0.5
309
309
310
- .. versionchanged :: 1.3
310
+ .. version-changed :: 1.3
311
311
The handlers' return value is now used.
312
312
313
313
.. event :: env-get-updated (app, env)
@@ -328,7 +328,7 @@ Here is a more detailed list of these events.
328
328
Emitted when Consistency checks phase. You can check consistency of
329
329
metadata for whole of documents.
330
330
331
- .. versionadded :: 1.6
331
+ .. version-added :: 1.6
332
332
333
333
.. event :: write-started (app, builder)
334
334
@@ -338,7 +338,7 @@ Here is a more detailed list of these events.
338
338
Emitted before the builder starts to
339
339
resolve and write documents.
340
340
341
- .. versionadded :: 7.4
341
+ .. version-added :: 7.4
342
342
343
343
.. event :: build-finished (app, exception)
344
344
@@ -352,7 +352,7 @@ Here is a more detailed list of these events.
352
352
raised no exception, *exception * will be ``None ``. This allows to customize
353
353
cleanup actions depending on the exception status.
354
354
355
- .. versionadded :: 0.5
355
+ .. version-added :: 0.5
356
356
357
357
Builder specific events
358
358
-----------------------
@@ -370,7 +370,7 @@ These events are emitted by specific builders.
370
370
371
371
You can add pages to write by returning an iterable from this event.
372
372
373
- .. versionadded :: 1.0
373
+ .. version-added :: 1.0
374
374
375
375
.. event :: html-page-context (app, pagename, templatename, context, doctree)
376
376
@@ -406,9 +406,9 @@ These events are emitted by specific builders.
406
406
:meth: `.Sphinx.add_js_file ` and :meth: `.Sphinx.add_css_file `
407
407
(since v3.5.0).
408
408
409
- .. versionadded :: 0.4
409
+ .. version-added :: 0.4
410
410
411
- .. versionchanged :: 1.3
411
+ .. version-changed :: 1.3
412
412
The return value can now specify a template name.
413
413
414
414
.. event :: linkcheck-process-uri (app, uri)
@@ -421,4 +421,4 @@ These events are emitted by specific builders.
421
421
422
422
The event handlers can modify the URI by returning a string.
423
423
424
- .. versionadded :: 4.1
424
+ .. version-added :: 4.1
0 commit comments