Merge pull request #4462 from tk0miya/use_event_role

doc: Use :event: role
This commit is contained in:
Takeshi KOMIYA 2018-01-20 21:58:53 +09:00 committed by GitHub
commit 70aa784f51
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions

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

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):