Merge pull request #7888 from McSinyx/imperative-napoleon

ext.napoleon: Add aliases Warn and Raise
sphinx-doc · Jun 29, 2020 · ec9af60 · ec9af60
2 parents e4c3e24 + 1a86506
commit ec9af60
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/CHANGES b/CHANGES
@@ -14,6 +14,7 @@ Features added
 --------------
 
 * #7853: C and C++, support parameterized GNU style attributes.
+* #7888: napoleon: Add aliases Warn and Raise.
 
 Bugs fixed
 ----------

diff --git a/doc/usage/extensions/napoleon.rst b/doc/usage/extensions/napoleon.rst
@@ -115,13 +115,15 @@ All of the following section headers are supported:
     * ``Parameters``
     * ``Return`` *(alias of Returns)*
     * ``Returns``
+    * ``Raise`` *(alias of Raises)*
     * ``Raises``
     * ``References``
     * ``See Also``
     * ``Tip``
     * ``Todo``
     * ``Warning``
     * ``Warnings`` *(alias of Warning)*
+    * ``Warn`` *(alias of Warns)*
     * ``Warns``
     * ``Yield`` *(alias of Yields)*
     * ``Yields``

diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py
@@ -162,13 +162,15 @@ def __init__(self, docstring: Union[str, List[str]], config: SphinxConfig = None
                 'parameters': self._parse_parameters_section,
                 'return': self._parse_returns_section,
                 'returns': self._parse_returns_section,
+                'raise': self._parse_raises_section,
                 'raises': self._parse_raises_section,
                 'references': self._parse_references_section,
                 'see also': self._parse_see_also_section,
                 'tip': partial(self._parse_admonition, 'tip'),
                 'todo': partial(self._parse_admonition, 'todo'),
                 'warning': partial(self._parse_admonition, 'warning'),
                 'warnings': partial(self._parse_admonition, 'warning'),
+                'warn': self._parse_warns_section,
                 'warns': self._parse_warns_section,
                 'yield': self._parse_yields_section,
                 'yields': self._parse_yields_section,