Sphinx documentation: how to reference a Python property?

Question

How can I reference a method, decorated with @property?

For simple methods, :py:meth: is working fine, but not for properties: it does not create a link to them.

Answer 1

You should use :py:attr: instead. This example works fine 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`
        """

Answer 2

This works for me. It renders MyClass.my_prop with the proper link.

:attr:`.MyClass.my_prop`

This renders just my_prop, with the same link.

:attr:`~.MyClass.my_prop`