Skip to content

Commit

Permalink
Merge pull request #10119 from Bibo-Joshi/elaborate-docs-on-nitpick_i…
Browse files Browse the repository at this point in the history
…gnore

Documentation: Mention `nitpick_ignore(_regex)` in docs of `warn-missing-reference`
  • Loading branch information
tk0miya committed Jan 22, 2022
2 parents 2be0630 + 84a6270 commit 0cc338f
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 0cc338f

Please sign in to comment.