IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Mention nitpick_ignore(_regex) in docs of warn-missing-reference

Browse Source
This commit is contained in:
Hinrich Mahler
2022-01-18 22:01:52 +01:00
parent 2be0630951
commit 84a6270685
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/extdev/appapi.rst
View File

@@ -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