Skip to content

Commit

Permalink
Mention nitpick_ignore(_regex) in docs of warn-missing-reference
Browse files Browse the repository at this point in the history
  • Loading branch information
Bibo-Joshi committed Jan 18, 2022
1 parent 2be0630 commit 84a6270
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/extdev/appapi.rst
Expand Up @@ -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

Expand Down

0 comments on commit 84a6270

Please sign in to comment.