[英]Prevent term ending in an underscore from appearing as hyperlink in Sphinx docs
我有一个类方法,其参数以下划线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
功能最底部此的页面,你可以看到它被格式化为一个超链接。
使用反斜杠来转义下划线。
from\_: str
Sender.
参考: https : //docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#escaping-mechanism
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.