From 84a627068578d265adf46e367f7633032dd2316c Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Tue, 18 Jan 2022 22:01:52 +0100 Subject: [PATCH] Mention nitpick_ignore(_regex) in docs of warn-missing-reference --- doc/extdev/appapi.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst index 7c331382c65..fc92a775cd5 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