mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
38d80c3d0f
Since python 3.9, `classmethod` starts to support creating a "class property". This supports to generate document for it.
44 lines
1.1 KiB
Python
44 lines
1.1 KiB
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.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):
|
|
actual = do_autodoc(app, 'property', 'target.properties.Foo.prop2')
|
|
assert list(actual) == [
|
|
'',
|
|
'.. py:property:: Foo.prop2',
|
|
' :module: target.properties',
|
|
' :classmethod:',
|
|
' :type: int',
|
|
'',
|
|
' docstring',
|
|
'',
|
|
]
|