diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-10-30 01:54:34 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-30 01:54:34 +0900 |
| commit | 68c89f471c2b302eb2797818bf7cabe604fc488a (patch) | |
| tree | 4cf2c871753360c2122e1a7082aae325a84190ac /sphinx | |
| parent | 751b7a025117c1eaceffa2dd0855ec783f5ecd3d (diff) | |
| parent | 439f75afd256ae259a72e39d1cf0e31711b94a85 (diff) | |
| download | sphinx-git-68c89f471c2b302eb2797818bf7cabe604fc488a.tar.gz | |
Merge pull request #8050 from keewis/preprocess-other-sections
Preprocess other sections
Diffstat (limited to 'sphinx')
| -rw-r--r-- | sphinx/ext/napoleon/docstring.py | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index b5c34a479..90f7ade52 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -699,6 +699,9 @@ class GoogleDocstring: m = self._name_rgx.match(_type) if m and m.group('name'): _type = m.group('name') + elif _xref_regex.match(_type): + pos = _type.find('`') + _type = _type[pos + 1:-1] _type = ' ' + _type if _type else '' _desc = self._strip_empty(_desc) _descs = ' ' + '\n '.join(_desc) if any(_desc) else '' @@ -1104,6 +1107,10 @@ class NumpyDocstring(GoogleDocstring): _name, _type = line, '' _name, _type = _name.strip(), _type.strip() _name = self._escape_args_and_kwargs(_name) + + if prefer_type and not _type: + _type, _name = _name, _type + if self._config.napoleon_preprocess_types: _type = _convert_numpy_type_spec( _type, @@ -1111,8 +1118,6 @@ class NumpyDocstring(GoogleDocstring): translations=self._config.napoleon_type_aliases or {}, ) - if prefer_type and not _type: - _type, _name = _name, _type indent = self._get_indent(line) + 1 _desc = self._dedent(self._consume_indented_block(indent)) _desc = self.__class__(_desc, self._config).lines() |