summaryrefslogtreecommitdiff
path: root/tests/test_ext_autodoc.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2020-05-24 23:34:09 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2020-05-31 23:59:32 +0900
commitfb2f777079506a6ed36077ae98c2b267d25b16b5 (patch)
tree56d0fff48bfe3a97c4c007739111a7ad341242cb /tests/test_ext_autodoc.py
parent640bb2e586f882df305568bf99aacb151120f84f (diff)
downloadsphinx-git-fb2f777079506a6ed36077ae98c2b267d25b16b5.tar.gz
Close #3610: autodoc: Support overloaded functions
Diffstat (limited to 'tests/test_ext_autodoc.py')
-rw-r--r--tests/test_ext_autodoc.py33
1 files changed, 33 insertions, 0 deletions
diff --git a/tests/test_ext_autodoc.py b/tests/test_ext_autodoc.py
index 5cc1f3c22..0a651950b 100644
--- a/tests/test_ext_autodoc.py
+++ b/tests/test_ext_autodoc.py
@@ -1787,6 +1787,39 @@ def test_final(app):
]
+@pytest.mark.sphinx('html', testroot='ext-autodoc')
+def test_overload(app):
+ options = {"members": None}
+ actual = do_autodoc(app, 'module', 'target.overload', options)
+ assert list(actual) == [
+ '',
+ '.. py:module:: target.overload',
+ '',
+ '',
+ '.. py:class:: Math()',
+ ' :module: target.overload',
+ '',
+ ' docstring',
+ '',
+ '',
+ ' .. py:method:: Math.sum(x: int, y: int) -> int',
+ ' Math.sum(x: float, y: float) -> float',
+ ' Math.sum(x: str, y: str) -> str',
+ ' :module: target.overload',
+ '',
+ ' docstring',
+ '',
+ '',
+ '.. py:function:: sum(x: int, y: int) -> int',
+ ' sum(x: float, y: float) -> float',
+ ' sum(x: str, y: str) -> str',
+ ' :module: target.overload',
+ '',
+ ' docstring',
+ '',
+ ]
+
+
@pytest.mark.sphinx('dummy', testroot='ext-autodoc')
def test_autodoc(app, status, warning):
app.builder.build_all()