防止以下划线结尾的术语在 Sphinx 文档中显示为超链接

Question

我有一个类方法，其参数以下划线结尾，from_我用它autoclass来生成该类的文档。我希望参数from_在 Sphinx 文档中显示为普通文本，但目前它显示为超链接。

这是带有文档字符串的类方法的简化版本：

class Twilio:

    def get_messages(to=None, from_=None):
        """
        Get messages.

        `Args:`
            to: str
                Receiver.
            from_: str
                Sender.
        `Returns:`
            Messages: dict
        """
        return fetch_messages(to=to, from_=from_)

我正在使用以下方法生成此类的文档：

.. autoclass :: Twilio
   :inherited-members:

问题可以在本页最底部的函数中看到，get_messages您可以看到它被格式化为超链接。

Answer 1

使用反斜杠转义下划线。

from\_: str
     Sender.

参考：https ://docutils.sourceforge.io/docs/ref/rst/restructedtext.html#escaping-mechanism