sphinx/tests/test_ext_autodoc_autoproperty.py
Takeshi KOMIYA 75f5122996 Fix #7383: autodoc: Support typehints for properties
py:property directive now outputs py:property directive to describe
its type annotation.
2021-03-13 22:51:46 +09:00

29 lines
748 B
Python

"""
test_ext_autodoc_autoproperty
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Test the autodoc extension. This tests mainly the Documenters; the auto
directives are tested in a test source file translated by test_build.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import pytest
from .test_ext_autodoc import do_autodoc
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_properties(app):
actual = do_autodoc(app, 'property', 'target.properties.Foo.prop')
assert list(actual) == [
'',
'.. py:property:: Foo.prop',
' :module: target.properties',
' :type: int',
'',
' docstring',
'',
]