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 #7079: Make autodoc_typehints=description formal

Browse Source
This commit is contained in:
Takeshi KOMIYA
2020-03-07 13:19:37 +09:00
parent 0e89979355
commit d517aa6c16
5 changed files with 16 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
tests/test_ext_autodoc_configs.py
View File

@@ -462,10 +462,9 @@ def test_mocked_module_imports(app, warning):
assert warning.getvalue() == ''
@pytest.mark.sphinx('html', testroot='ext-autodoc')
@pytest.mark.sphinx('html', testroot='ext-autodoc',
confoverrides={'autodoc_typehints': "signature"})
def test_autodoc_typehints_signature(app):
app.config.autodoc_typehints = "signature"
options = {"members": None,
"undoc-members": True}
actual = do_autodoc(app, 'module', 'target.typehints', options)
@@ -513,10 +512,9 @@ def test_autodoc_typehints_signature(app):
]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
@pytest.mark.sphinx('html', testroot='ext-autodoc',
confoverrides={'autodoc_typehints': "none"})
def test_autodoc_typehints_none(app):
app.config.autodoc_typehints = "none"
options = {"members": None,
"undoc-members": True}
actual = do_autodoc(app, 'module', 'target.typehints', options)
@@ -564,8 +562,7 @@ def test_autodoc_typehints_none(app):
@pytest.mark.sphinx('text', testroot='ext-autodoc',
confoverrides={'extensions': ['sphinx.ext.autodoc.typehints'],
'autodoc_typehints': 'description'})
confoverrides={'autodoc_typehints': "description"})
def test_autodoc_typehints_description(app):
app.build()
context = (app.outdir / 'index.txt').read_text()