Sphinx documentation: how to reference a Python property? -


how can reference method, decorated @property?

for simple methods, :py:meth: working fine, not properties: not create link them.

you should use :py:attr: instead. example works fine me:

class someclass(object):     """this docstring of someclass."""      @property     def some_property(self):         """this docstring of some_property"""         return none      def some_method(self):         """this docstring of some_method.          , reference :py:attr:`~some_property`         """ 

Comments

Popular posts from this blog

matlab - "Contour not rendered for non-finite ZData" -

delphi - Indy UDP Read Contents of Adata -

javascript - Any ideas when Firefox is likely to implement lengthAdjust and textLength? -