Link do metody klasy w docstringu języka Python

Chcę dodać link do metody w mojej klasie z poziomu dokumentacji innej metody tej samej klasy. Chcę, aby link działał w sfinksie, a preferencyjnie również w Spyder i innych Python IDE.

Wypróbowałem kilka opcji i znalazłem tylko jedną, która działa, ale jest uciążliwa.

Załóżmy, że następująca struktura w mymodule.py

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

Wypróbowałem następujące opcje <link to foo>:

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

Jedynym, który skutecznie tworzy link, jest: func: `mymodule.MyClass.foo`, ale link jest wyświetlany jako mymodule.MyClass.foo()i chcę, aby był wyświetlany jako foo()lub foo.
Żadna z powyższych opcji nie tworzy linku w Spyder.

Dzięki za pomoc.

Rozwiązaniem, które działa w przypadku Sphinx, jest poprzedzenie odwołania znakiem ~.

Zgodnie z dokumentacją Sphinx dotyczącą składni odsyłaczy ,

Jeśli przedrostek treści zostanie poprzedzony znakiem ~, tekst odsyłacza będzie tylko ostatnim składnikiem celu. Na przykład: py: meth: ~Queue.Queue.getbędzie odnosić się do Queue.Queue.get, ale jako tekst odsyłacza wyświetli get.

Tak więc odpowiedź brzmi:

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

Powoduje to, że kod HTML wygląda następująco: This method does the same as foo()i foo()jest linkiem.

Należy jednak pamiętać, że może to nie być wyświetlane w Spyder jako łącze.

Jeśli chcesz ręcznie określić tekst linku, możesz użyć:

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

Aby uzyskać więcej informacji, sprawdź odsyłacze do obiektów języka Python .

Wydaje mi się, że wystarczy dodać __name__lub __doc__do wyrażenia, aby uzyskać to, czego chcesz.
Nadal nie jestem pewien, czy poprawnie zrozumiałem cel

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__

wynik

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

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