def _parse_examples_section(self, section):
# type: (unicode) -> List[unicode]
labels = {
'example': _('Example'),
'examples': _('Examples'),
} # type: Dict[unicode, unicode]
use_admonition = self._config.napoleon_use_admonition_for_examples
label = labels.get(section.lower(), section)
return self._parse_generic_section(label, use_admonition)
def _parse_parameters_section(self, section):
# type: (unicode) -> List[unicode]
labels = {
"args": _("Parameters"),
"arguments": _("Parameters"),
"parameters": _("Parameters"),
} # type: Dict[unicode, unicode]
label = labels.get(section.lower(), section)
fields = self._consume_fields()
if self._config.napoleon_use_param:
return self._format_docutils_params(fields)
return self._format_fields(label, fields)
def _parse_parameters_section(self, section):
# type: (unicode) -> List[unicode]
labels = {
'args': _('Parameters'),
'arguments': _('Parameters'),
'parameters': _('Parameters'),
} # type: Dict[unicode, unicode]
use_admonition = self._config.napoleon_use_admonition_for_examples
label = labels.get(section.lower(), section)
fields = self._consume_fields()
if self._config.napoleon_use_param:
return self._format_docutils_params(fields)
else:
return self._format_fields(label, fields)
def _parse_parameters_section(self, section):
# type: (unicode) -> List[unicode]
fields = self._consume_fields()
if self._config.napoleon_use_param:
return self._format_docutils_params(fields)
else:
return self._format_fields(_('Parameters'), fields)
def _parse_keyword_arguments_section(self, section):
# type: (unicode) -> List[unicode]
fields = self._consume_fields()
if self._config.napoleon_use_keyword:
return self._format_docutils_params(fields,
field_role="keyword",
type_role="kwtype")
else:
return self._format_fields(_('Keyword Arguments'), fields)
def _parse_yields_section(self, section):
# type: (unicode) -> List[unicode]
fields = self._consume_returns_section()
return self._format_fields(_('Yields'), fields)
def _parse_warns_section(self, section):
# type: (unicode) -> List[unicode]
return self._format_fields(_('Warns'), self._consume_fields())
def _parse_references_section(self, section):
# type: (unicode) -> List[unicode]
use_admonition = self._config.napoleon_use_admonition_for_references
return self._parse_generic_section(_('References'), use_admonition)
def _parse_other_parameters_section(self, section):
# type: (unicode) -> List[unicode]
return self._format_fields(_('Other Parameters'),
self._consume_fields())
