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

Close #2106: autodoc: Support multiple signatures on docstring

Browse Source
This commit is contained in:
Takeshi KOMIYA
2020-05-30 13:15:19 +09:00
parent 9988d5ce26
commit 800dcf0f0a
5 changed files with 91 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/usage/extensions/autodoc.rst
View File

@@ -454,7 +454,14 @@ There are also config values that you can set:
looks like a signature, use the line as the signature and remove it from the
docstring content.
If the signature line ends with backslash, autodoc considers the function has
multiple signatures and look at the next line of the docstring. It is useful
for overloaded function.
.. versionadded:: 1.1
.. versionchanged:: 3.1
Support overloaded signatures
.. confval:: autodoc_mock_imports