1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
"""Test the autodoc extension.
This tests mainly the Documenters; the auto directives are tested in a test
source file translated by test_build.
"""
from __future__ import annotations
from typing import TYPE_CHECKING
import pytest
from tests.test_extensions.autodoc_util import do_autodoc
if TYPE_CHECKING:
from sphinx.testing.util import SphinxTestApp
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_properties(app: SphinxTestApp) -> None:
actual = do_autodoc(app, 'property', 'target.properties.Foo.prop1')
assert list(actual) == [
'',
'.. py:property:: Foo.prop1',
' :module: target.properties',
' :type: int',
'',
' docstring',
'',
]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_class_properties(app: SphinxTestApp) -> None:
actual = do_autodoc(app, 'property', 'target.properties.Foo.prop2')
assert list(actual) == [
'',
'.. py:property:: Foo.prop2',
' :module: target.properties',
' :classmethod:',
' :type: int',
'',
' docstring',
'',
]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_properties_with_type_comment(app: SphinxTestApp) -> None:
actual = do_autodoc(
app, 'property', 'target.properties.Foo.prop1_with_type_comment'
)
assert list(actual) == [
'',
'.. py:property:: Foo.prop1_with_type_comment',
' :module: target.properties',
' :type: int',
'',
' docstring',
'',
]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_class_properties_with_type_comment(app: SphinxTestApp) -> None:
actual = do_autodoc(
app, 'property', 'target.properties.Foo.prop2_with_type_comment'
)
assert list(actual) == [
'',
'.. py:property:: Foo.prop2_with_type_comment',
' :module: target.properties',
' :classmethod:',
' :type: int',
'',
' docstring',
'',
]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_cached_properties(app: SphinxTestApp) -> None:
actual = do_autodoc(app, 'property', 'target.cached_property.Foo.prop')
assert list(actual) == [
'',
'.. py:property:: Foo.prop',
' :module: target.cached_property',
' :type: int',
'',
]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_cached_properties_with_type_comment(app: SphinxTestApp) -> None:
actual = do_autodoc(
app, 'property', 'target.cached_property.Foo.prop_with_type_comment'
)
assert list(actual) == [
'',
'.. py:property:: Foo.prop_with_type_comment',
' :module: target.cached_property',
' :type: int',
'',
]
|
