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

doc: Use :event: role

Browse Source
This commit is contained in:
Takeshi KOMIYA 2018-01-20 21:18:54 +09:00
parent ae620e16f7
commit 6770c6ae67
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sphinx/domains/__init__.py
View File

@ -281,11 +281,11 @@ class Domain(object):
cross-reference.
If no resolution can be found, None can be returned; the xref node will
then given to the 'missing-reference' event, and if that yields no
then given to the :event:`missing-reference` event, and if that yields no
resolution, replaced by *contnode*.
The method can also raise :exc:`sphinx.environment.NoUri` to suppress
the 'missing-reference' event being emitted.
the :event:`missing-reference` event being emitted.
"""
pass

2
sphinx/io.py
View File

@ -157,7 +157,7 @@ class SphinxBaseFileInput(FileInput):
"""A base class of SphinxFileInput.
It supports to replace unknown Unicode characters to '?'. And it also emits
Sphinx events ``source-read`` on reading.
Sphinx events :event:`source-read` on reading.
"""
def __init__(self, app, env, *args, **kwds):