summaryrefslogtreecommitdiff
path: root/doc/extdev
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2022-02-14 03:03:40 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2022-02-14 03:03:40 +0900
commit8b23f6db12d9fcdb6e1ca2015ea32e3e2e1fbdb6 (patch)
tree45c07e0a74fcace45cfb43d7491bab9a98f88087 /doc/extdev
parentd7c6fa853ce433640331deab837b3a0c0edb3c9d (diff)
parent07110b7557a552ecfe702bdd6a2d2f9685cb1af9 (diff)
downloadsphinx-git-8b23f6db12d9fcdb6e1ca2015ea32e3e2e1fbdb6.tar.gz
Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9'
Diffstat (limited to 'doc/extdev')
-rw-r--r--doc/extdev/appapi.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst
index 7c331382c..fc92a775c 100644
--- a/doc/extdev/appapi.rst
+++ b/doc/extdev/appapi.rst
@@ -298,7 +298,9 @@ Here is a more detailed list of these events.
Emitted when a cross-reference to an object cannot be resolved even after
:event:`missing-reference`. If the event handler can emit warnings for
- the missing reference, it should return ``True``.
+ the missing reference, it should return ``True``. The configuration variables
+ :confval:`nitpick_ignore` and :confval:`nitpick_ignore_regex` prevent the
+ event from being emitted for the corresponding nodes.
.. versionadded:: 3.4