summaryrefslogtreecommitdiff
path: root/sphinx/events.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2020-08-08 20:06:46 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2020-11-03 02:27:43 +0900
commit0e98e9b1a8ade24acf1d91f59aa90e8b1e179b19 (patch)
tree6fdb9ca354e92e1fe28efb6fbf9fdabf45e77f15 /sphinx/events.py
parent487b8436c6e8dc596db4b8d4d06e9145105a2ac2 (diff)
downloadsphinx-git-0e98e9b1a8ade24acf1d91f59aa90e8b1e179b19.tar.gz
Fix #6914: Emit a detailed warning when failed to resolve :ref:
To be clear the ambiguous warning for missing-reference :ref:, this separates the warning to missing-label and missing-caption. To emit a warning dynamically, this also adds a new event: `warn-missing-reference` to customize warning messages via event handlers.
Diffstat (limited to 'sphinx/events.py')
-rw-r--r--sphinx/events.py1
1 files changed, 1 insertions, 0 deletions
diff --git a/sphinx/events.py b/sphinx/events.py
index 82a52d762..214654706 100644
--- a/sphinx/events.py
+++ b/sphinx/events.py
@@ -46,6 +46,7 @@ core_events = {
'doctree-read': 'the doctree before being pickled',
'env-merge-info': 'env, read docnames, other env instance',
'missing-reference': 'env, node, contnode',
+ 'warn-missing-reference': 'domain, node',
'doctree-resolved': 'doctree, docname',
'env-updated': 'env',
'html-collect-pages': 'builder',