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

Add a new extension: sphinx.ext.autodoc.typehints

Browse Source
This commit is contained in:
Takeshi KOMIYA
2020-01-12 01:54:57 +09:00
parent 2e22e96061
commit 5397664d42
6 changed files with 191 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
tests/test_ext_autodoc_configs.py
View File

@@ -540,6 +540,24 @@ def test_autodoc_typehints_none(app):
]
@pytest.mark.sphinx('text', testroot='ext-autodoc',
confoverrides={'extensions': ['sphinx.ext.autodoc.typehints'],
'autodoc_typehints': 'description'})
def test_autodoc_typehints_description(app):
app.build()
context = (app.outdir / 'index.txt').text()
assert ('target.typehints.incr(a, b=1)\n'
'\n'
' Parameters:\n'
' * **a** (*int*) --\n'
'\n'
' * **b** (*int*) --\n'
'\n'
' Return type:\n'
' int\n'
in context)
@pytest.mark.sphinx('html', testroot='ext-autodoc')
@pytest.mark.filterwarnings('ignore:autodoc_default_flags is now deprecated.')
def test_merge_autodoc_default_flags1(app):