summaryrefslogtreecommitdiff
path: root/doc/extdev/appapi.rst
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2020-06-04 00:18:30 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2020-06-04 00:18:30 +0900
commit068b9b5738b4d41a25e14d56d6f6b55f3bc8d443 (patch)
treef58f2d43d8a54545ae8a0c51ffe99c310864710d /doc/extdev/appapi.rst
parent88a3548a8268d3b99f2d79db08fe65da7d691592 (diff)
parent9b45b00bd4cee7dad96b98cec0224f88a84ef40a (diff)
downloadsphinx-git-068b9b5738b4d41a25e14d56d6f6b55f3bc8d443.tar.gz
Merge branch '3.x'
Diffstat (limited to 'doc/extdev/appapi.rst')
-rw-r--r--doc/extdev/appapi.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst
index 961558600..d5b1a8a98 100644
--- a/doc/extdev/appapi.rst
+++ b/doc/extdev/appapi.rst
@@ -230,11 +230,15 @@ connect handlers to the events. Example:
.. event:: missing-reference (app, env, node, contnode)
- Emitted when a cross-reference to a Python module or object cannot be
- resolved. If the event handler can resolve the reference, it should return a
+ Emitted when a cross-reference to an object cannot be resolved.
+ If the event handler can resolve the reference, it should return a
new docutils node to be inserted in the document tree in place of the node
*node*. Usually this node is a :class:`reference` node containing *contnode*
as a child.
+ If the handler can not resolve the cross-reference,
+ it can either return ``None`` to let other handlers try,
+ or raise :class:`NoUri` to prevent other handlers in trying and suppress
+ a warning about this cross-reference being unresolved.
:param env: The build environment (``app.builder.env``).
:param node: The :class:`pending_xref` node to be resolved. Its attributes