Liên kết đến phương thức lớp trong python docstring

Tôi muốn thêm liên kết đến một phương thức trong lớp của mình từ bên trong docstring của một phương thức khác cùng lớp. Tôi muốn liên kết hoạt động trong sphinx và ưu tiên cũng trong Spyder và các IDE Python khác.

Tôi đã thử một số tùy chọn và chỉ tìm thấy một tùy chọn hoạt động, nhưng nó cồng kềnh.

Giả sử cấu trúc sau trong mymodule.py

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

Tôi đã thử các tùy chọn sau cho <link to foo>:

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

Liên kết duy nhất tạo liên kết hiệu quả là: func: `mymodule.MyClass.foo`, nhưng liên kết được hiển thị dưới dạng mymodule.MyClass.foo()và tôi muốn một liên kết được hiển thị là foo()hoặc foo.
Không có tùy chọn nào ở trên tạo ra liên kết trong Spyder.

Cảm ơn bạn đã giúp đỡ.

Giải pháp hiệu quả cho Sphinx là thêm tiền tố tham chiếu ~.

Theo tài liệu Sphinx về Cú pháp tham chiếu chéo ,

Nếu bạn đặt tiền tố nội dung bằng ~, văn bản liên kết sẽ chỉ là thành phần cuối cùng của đích. Ví dụ: py: meth: ~Queue.Queue.getsẽ tham chiếu đến Queue.Queue.get nhưng chỉ hiển thị get dưới dạng văn bản liên kết.

Vì vậy, câu trả lời là:

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

Điều này dẫn đến một html trông giống như sau: This method does the same as foo()và foo()là một liên kết.

Tuy nhiên, lưu ý rằng điều này có thể không hiển thị trong Spyder dưới dạng một liên kết.

Nếu bạn muốn chỉ định thủ công văn bản của liên kết, bạn có thể sử dụng:

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

Để biết thêm thông tin, hãy kiểm tra Tham chiếu chéo các đối tượng Python .

Đối với tôi, dường như bạn chỉ cần thêm __name__hoặc __doc__vào biểu thức của mình để có được những gì bạn muốn.
Tôi vẫn không chắc mình đã hiểu đúng mục đích

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__

kết quả

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

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