Sphinx documentation: how to reference a Python property?

Question

How can I refer to the method decorated with @property ?

For simple methods :py:meth: works fine, but not for properties: it doesn't create a link to them.

Answer 1

Instead, use :py:attr: This example is great for me:

 class SomeClass(object): """This is the docstring of SomeClass.""" @property def some_property(self): """This is the docstring of some_property""" return None def some_method(self): """This is the docstring of some_method. And this is a reference to :py:attr:`~some_property` """