链接到python docstring中的类方法

我想从同一个类的另一个方法的文档字符串中添加指向我的类中的方法的链接。我希望链接在sphinx中工作，最好在Spyder和其他Python IDE中工作。

我尝试了几种选择，但发现只有一种可行，但这很麻烦。

假设以下结构 mymodule.py

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

我尝试了以下选项<link to foo>：

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

唯一有效产生链接的链接是：func：`mymodule.MyClass.foo`，但是该链接显示为mymodule.MyClass.foo()，我想要一个显示为foo()或的链接foo。
上面的选项均未在Spyder中生成链接。

谢谢你的帮助。

适用于Sphinx的解决方案是在引用前面加上~。

根据Sphinx有关交叉引用语法的文档，

如果在内容前面加上〜，则链接文本将仅是目标的最后一个组成部分。例如，：py：meth：~Queue.Queue.get将引用Queue.Queue.get，但仅将get作为链接文本显示。

因此答案是：

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

这导致html看起来像这样：This method does the same as foo()，并且 foo()是一个链接。

但是，请注意，这可能不会在Spyder中显示为链接。

如果要手动指定链接的文本，可以使用：

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

有关更多信息，请签出交叉引用Python对象。

在我看来，您只需添加__name__或添加__doc__您的表情即可获得所需的内容。
我仍然不确定是否已经正确理解了目标

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__

结果

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

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