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

refactor: separate ReSTMarkup.get_index_text() to subclasses

Browse Source 
According to the principle, the parent class; ReSTMarkup should not
know about children.
This commit is contained in:
Takeshi KOMIYA 2019-04-14 19:19:02 +09:00
parent 11a4e47d62
commit c26d5d7ecd
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sphinx/domains/rst.py
View File

@ -58,10 +58,6 @@ class ReSTMarkup(ObjectDescription):
def get_index_text(self, objectname, name): def get_index_text(self, objectname, name):
# type: (str, str) -> str # type: (str, str) -> str
if self.objtype == 'directive':
return _('%s (directive)') % name
elif self.objtype == 'role':
return _('%s (role)') % name
return '' return ''
@ -96,6 +92,10 @@ class ReSTDirective(ReSTMarkup):
signode += addnodes.desc_addname(args, args) signode += addnodes.desc_addname(args, args)
return name return name
def get_index_text(self, objectname, name):
# type: (str, str) -> str
return _('%s (directive)') % name
class ReSTRole(ReSTMarkup): class ReSTRole(ReSTMarkup):
""" """
@ -106,6 +106,10 @@ class ReSTRole(ReSTMarkup):
signode += addnodes.desc_name(':%s:' % sig, ':%s:' % sig) signode += addnodes.desc_name(':%s:' % sig, ':%s:' % sig)
return sig return sig
def get_index_text(self, objectname, name):
# type: (str, str) -> str
return _('%s (role)') % name
class ReSTDomain(Domain): class ReSTDomain(Domain):
"""ReStructuredText domain.""" """ReStructuredText domain."""