diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-01-22 11:59:34 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-22 11:59:34 +0900 |
| commit | 0cc338f9c5e9ba29bb82de40129e357d54439418 (patch) | |
| tree | 196df8985e41ea6a1108a32105969490b18cedd1 | |
| parent | 2be06309518d9401a42880bb5b4321dfdd1e5e90 (diff) | |
| parent | 84a627068578d265adf46e367f7633032dd2316c (diff) | |
| download | sphinx-git-0cc338f9c5e9ba29bb82de40129e357d54439418.tar.gz | |
Merge pull request #10119 from Bibo-Joshi/elaborate-docs-on-nitpick_ignore
Documentation: Mention `nitpick_ignore(_regex)` in docs of `warn-missing-reference`
| -rw-r--r-- | doc/extdev/appapi.rst | 4 |
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 |