Python docstring'deki sınıf yöntemine bağlantı

Sınıfımdaki bir yönteme, aynı sınıftaki başka bir yöntemin docstring'inden bir bağlantı eklemek istiyorum. Bağlantının sphinx'te ve tercihen Spyder ve diğer Python IDE'lerinde çalışmasını istiyorum.

Birkaç seçenek denedim ve işe yarayan bir tane buldum, ancak bu külfetli.

Aşağıdaki yapıyı varsayalım mymodule.py

def class MyClass():
    def foo(self):
        print 'foo'
    def bar(self):
        """This method does the same as <link to foo>"""
        print 'foo'

Aşağıdaki seçenekleri denedim <link to foo>:

• : func: `foo`
• : func: `self.foo`
• : func: `MyClass.foo`
• : func: `mymodule.MyClass.foo`

Etkin bir bağlantı üreten tek: func: "mymodule.MyClass.foo", ancak bağlantı olarak gösteriliyor mymodule.MyClass.foo()ve foo()veya olarak gösterilen bir bağlantı istiyorum foo.
Yukarıdaki seçeneklerden hiçbiri Spyder'da bir bağlantı oluşturmaz.

Yardımınız için teşekkürler.

Sphinx için işe yarayan çözüm, referansın önekini kullanmaktır ~.

Çapraz Referans Sözdizimi hakkındaki Sphinx belgelerine göre ,

İçeriğin başına ~ eklerseniz, bağlantı metni hedefin yalnızca son bileşeni olur. Örneğin ~Queue.Queue.get,: py: meth: Queue.Queue.get'e başvurur, ancak bağlantı metni olarak yalnızca get görüntülenir.

Yani cevap şu:

class MyClass():
    def foo(self):
        print 'foo'
    def bar(self):
        """This method does the same as :func:`~mymodule.MyClass.foo`"""
        print 'foo'

Bu This method does the same as foo(), foo()şu şekilde görünen bir html ile sonuçlanır: ve bir bağlantıdır.

Ancak, bunun Spyder'da bir bağlantı olarak görüntülenmeyebileceğini unutmayın.

Bağlantının metnini manuel olarak belirtmek isterseniz kullanabilirsiniz:

:func:`my text <mymodule.MyClass.foo>`

Daha fazla bilgi için Python nesnelerine çapraz referans verme konusuna bakın .

Bana öyle geliyor ki, istediğinizi elde etmek için ifadenize __name__ya da eklemeniz __doc__gerekiyor.
Hala amacı doğru anladığımdan emin değilim

class MyClass():
    def foo(self):
        """I am the docstring of foo"""
        print 'foo'
    def bar(self):
        """This method does the same as <link to foo>"""
        print 'foo'

print
print MyClass.foo
print MyClass.foo.__name__
print MyClass.foo.__doc__
print
print MyClass.__dict__['foo']
print MyClass.__dict__['foo'].__name__
print MyClass.__dict__['foo'].__doc__

sonuç

<unbound method MyClass.foo>
foo
I am the docstring of foo

<function foo at 0x011C27B0>
foo
I am the docstring of foo