diff options
author | Georg Brandl <georg@python.org> | 2009-07-03 13:34:08 +0200 |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2009-07-03 13:34:08 +0200 |
commit | c8e8b1bfd4d76f13b51cd86b48cb32ccbe7559e0 (patch) | |
tree | 6d2a736922487d83b6a850e26a190e2ada1e9933 /sphinx/directives/desc.py | |
parent | 1f18db60a49e0fc6552bcfd11fe4b2be5153c68a (diff) | |
download | sphinx-git-c8e8b1bfd4d76f13b51cd86b48cb32ccbe7559e0.tar.gz |
Use a new "lazy" gettext function instead of using dummy _() to help text extraction.
Diffstat (limited to 'sphinx/directives/desc.py')
-rw-r--r-- | sphinx/directives/desc.py | 47 |
1 files changed, 21 insertions, 26 deletions
diff --git a/sphinx/directives/desc.py b/sphinx/directives/desc.py index 47c640b5e..666397c39 100644 --- a/sphinx/directives/desc.py +++ b/sphinx/directives/desc.py @@ -15,6 +15,7 @@ from docutils.parsers.rst import directives from sphinx import addnodes from sphinx.domains import Domain, domains +from sphinx.locale import l_ from sphinx.util import ws_re from sphinx.util.compat import Directive, directive_dwim @@ -84,8 +85,6 @@ class DescDirective(Directive): 'module': directives.unchanged, } - _ = lambda x: x # make gettext extraction in constants possible - doc_fields_with_arg = { 'param': '%param', 'parameter': '%param', @@ -95,23 +94,23 @@ class DescDirective(Directive): 'kwarg': '%param', 'kwparam': '%param', 'type': '%type', - 'raises': _('Raises'), - 'raise': 'Raises', - 'exception': 'Raises', - 'except': 'Raises', - 'var': _('Variable'), - 'ivar': 'Variable', - 'cvar': 'Variable', - 'returns': _('Returns'), - 'return': 'Returns', + 'raises': l_('Raises'), + 'raise': l_('Raises'), + 'exception': l_('Raises'), + 'except': l_('Raises'), + 'var': l_('Variable'), + 'ivar': l_('Variable'), + 'cvar': l_('Variable'), + 'returns': l_('Returns'), + 'return': l_('Returns'), } doc_fields_with_linked_arg = ('raises', 'raise', 'exception', 'except') doc_fields_without_arg = { - 'returns': 'Returns', - 'return': 'Returns', - 'rtype': _('Return type'), + 'returns': l_('Returns'), + 'return': l_('Returns'), + 'rtype': l_('Return type'), } def handle_doc_fields(self, node): @@ -132,7 +131,7 @@ class DescDirective(Directive): fname, fbody = field try: typ, obj = fname.astext().split(None, 1) - typdesc = _(self.doc_fields_with_arg[typ]) + typdesc = self.doc_fields_with_arg[typ] if _is_only_paragraph(fbody): children = fbody.children[0].children else: @@ -176,7 +175,7 @@ class DescDirective(Directive): except (KeyError, ValueError): fnametext = fname.astext() try: - typ = _(self.doc_fields_without_arg[fnametext]) + typ = self.doc_fields_without_arg[fnametext] except KeyError: # at least capitalize the field name typ = fnametext.capitalize() @@ -499,14 +498,14 @@ class ClassmemberDesc(PythonDesc): clsname, methname = name.rsplit('.', 1) except ValueError: if modname: - return '%s() (in module %s)' % (name, modname) + return _('%s() (in module %s)') % (name, modname) else: return '%s()' % name if modname: - return '%s() (%s.%s class method)' % (methname, modname, - clsname) + return _('%s() (%s.%s class method)') % (methname, modname, + clsname) else: - return '%s() (%s class method)' % (methname, clsname) + return _('%s() (%s class method)') % (methname, clsname) elif self.desctype == 'attribute': try: clsname, attrname = name.rsplit('.', 1) @@ -692,7 +691,7 @@ class GenericDesc(DescDirective): signode['ids'].append(targetname) self.state.document.note_explicit_target(signode) if indextemplate: - indexentry = _(indextemplate) % (name,) + indexentry = indextemplate % (name,) indextype = 'single' colon = indexentry.find(':') if colon != -1: @@ -757,17 +756,13 @@ class DefaultDomain(Directive): # Note: the target directive is not registered here, it is used by the # application when registering additional xref types. -_ = lambda x: x - # Generic cross-reference types; they can be registered in the application; # the directives are either desc_directive or target_directive. additional_xref_types = { # directive name: (role name, index text, function to parse the desc node) - 'envvar': ('envvar', _('environment variable; %s'), None), + 'envvar': ('envvar', l_('environment variable; %s'), None), } -del _ - directives.register_directive('default-domain', directive_dwim(DefaultDomain)) directives.register_directive('describe', directive_dwim(DescDirective)) |