-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix #7383: autodoc: Support typehints for properties
py:property directive now outputs py:property directive to describe its type annotation.
- Loading branch information
Showing
7 changed files
with
77 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
class Foo: | ||
"""docstring""" | ||
|
||
@property | ||
def prop(self) -> int: | ||
"""docstring""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
""" | ||
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', | ||
'', | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters