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

Respect add_module_names for index entries.

Browse Source
This commit is contained in:
Georg Brandl 2008-10-25 16:47:14 +00:00
parent 528a06ff4e
commit 8c39c19bf3
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
sphinx/directives/desc.py
View File

@ -20,7 +20,7 @@ ws_re = re.compile(r'\s+')
# ------ information units --------------------------------------------------------- # ------ information units ---------------------------------------------------------
def desc_index_text(desctype, module, name): def desc_index_text(desctype, module, name, add_modules):
if desctype == 'function': if desctype == 'function':
if not module: if not module:
return _('%s() (built-in function)') % name return _('%s() (built-in function)') % name
@ -41,7 +41,7 @@ def desc_index_text(desctype, module, name):
return _('%s() (in module %s)') % (name, module) return _('%s() (in module %s)') % (name, module)
else: else:
return '%s()' % name return '%s()' % name
if module: if module and add_modules:
return _('%s() (%s.%s method)') % (methname, module, clsname) return _('%s() (%s.%s method)') % (methname, module, clsname)
else: else:
return _('%s() (%s method)') % (methname, clsname) return _('%s() (%s method)') % (methname, clsname)
@ -53,7 +53,7 @@ def desc_index_text(desctype, module, name):
return _('%s() (in module %s)') % (name, module) return _('%s() (in module %s)') % (name, module)
else: else:
return '%s()' % name return '%s()' % name
if module: if module and add_modules:
return _('%s() (%s.%s static method)') % (methname, module, clsname) return _('%s() (%s.%s static method)') % (methname, module, clsname)
else: else:
return _('%s() (%s static method)') % (methname, clsname) return _('%s() (%s static method)') % (methname, clsname)
@ -65,7 +65,7 @@ def desc_index_text(desctype, module, name):
return _('%s (in module %s)') % (name, module) return _('%s (in module %s)') % (name, module)
else: else:
return name return name
if module: if module and add_modules:
return _('%s (%s.%s attribute)') % (attrname, module, clsname) return _('%s (%s.%s attribute)') % (attrname, module, clsname)
else: else:
return _('%s (%s attribute)') % (attrname, clsname) return _('%s (%s attribute)') % (attrname, clsname)
@ -455,7 +455,8 @@ def desc_directive(desctype, arguments, options, content, lineno,
env.note_descref(fullname, desctype, lineno) env.note_descref(fullname, desctype, lineno)
names.append(name) names.append(name)
indextext = desc_index_text(desctype, module, name) indextext = desc_index_text(desctype, module, name,
env.config.add_module_names)
inode['entries'].append(('single', indextext, fullname, fullname)) inode['entries'].append(('single', indextext, fullname, fullname))
subnode = addnodes.desc_content() subnode = addnodes.desc_content()