如何解决防止以下划线结尾的字词在Sphinx文档中显示为超链接
我有一个类方法,其参数以下划线from_
结尾,并且我正在使用autoclass
生成该类的文档。我希望参数from_
在我的Sphinx文档中显示为普通文本,但当前它显示为超链接。
这是带有docstring的class方法的简化版本:
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:
在此page底部的get_messages
函数中可以看到问题,您可以看到它被格式化为超链接。
解决方法
使用反斜杠转义下划线。
final checkBox = CheckboxListTile(
contentPadding: EdgeInsets.all(0),title: Text("Remember Me",style: TextStyle(fontSize: 15.0)),selected: checkBoxState,value: checkBoxState,checkColor: Colors.white,activeColor: Colors.grey,controlAffinity: ListTileControlAffinity.leading,onChanged: (newValue) {
setState(() {
checkBoxState = newValue;
});
},);
参考:https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#escaping-mechanism
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。