Pythondocstringのクラスメソッドへのリンク

同じクラスの別のメソッドのdocstring内から、クラスのメソッドへのリンクを追加したいと思います。リンクをsphinxで機能させ、優先的にSpyderやその他のPythonIDEでも機能させたい。

私はいくつかのオプションを試し、うまくいくものを1つだけ見つけましたが、それは面倒です。

次の構造を 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