如何防止Sphinx将URL转换为超链接?

12

我在文档中偶尔使用“垃圾”网址作为示例,并不希望它们成为无用的链接。是否有任何语法可以使这些网址不是超链接?

2个回答

23

有三种方法可以格式化这样的URL,使它们不成为超链接。第一种方法是将示例URL视为其他代码示例,并将其用反引号括起来,如下所示:

open ``http://www.example.com`` in a web browser
第二种方法是使用Sphinx :samp: 角色,像这样:
open :samp:`http://www.example.com` in a web browser

:samp: 角色可让您强调变量部分。例如,您可以这样指示用户选择的端口号:

open :samp:`http://www.example.com:{port}` in a web browser

同时单词port会被强调且括号将被省略。

最后一个选项是在示例URL前加上反斜杠,像这样:

open \http://www.example.com in a web browser

该URL将显示为普通文本,没有超链接或任何特殊格式。


2
除了@ddbeck的回答之外,如果要转义电子邮件地址,请在@前面加上斜杠。
login\@<hostname>

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接