ลิงก์ไปยังเมธอดคลาสใน python docstring

ฉันต้องการเพิ่มลิงก์ไปยังเมธอดในคลาสของฉันจากภายใน docstring ของเมธอดอื่นของคลาสเดียวกัน ฉันต้องการให้ลิงก์ทำงานในสฟิงซ์และควรอยู่ใน 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() ไม่มีตัวเลือกใดข้างต้นสร้างลิงค์ใน Spyderfoo

ขอบคุณสำหรับความช่วยเหลือของคุณ.

~วิธีการแก้ปัญหาที่เหมาะกับสฟิงซ์เป็นคำนำหน้าอ้างอิงด้วย

ตามเอกสารสฟิงซ์ในข้ามอ้างอิงไวยากรณ์ ,

หากคุณนำหน้าเนื้อหาด้วย ~ ข้อความลิงก์จะเป็นส่วนประกอบสุดท้ายของเป้าหมายเท่านั้น ตัวอย่างเช่น: py: meth: ~Queue.Queue.getจะอ้างถึง Queue.Queue.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>`

สำหรับข้อมูลเพิ่มเติมโปรดชำระเงินข้ามอ้างอิงวัตถุหลาม

สำหรับฉันแล้วดูเหมือนว่าคุณต้องเพิ่ม__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