如何在 reStructuredText 中为文本添加下划线？

Question

当然，在网络上，下划线表示超链接，但是如果我需要下划线而不是超链接怎么办？

Answer 1

我在此处提出了类似的问题。尝试这样：

.. role:: underline
    :class: underline

在文档中，可以按如下方式应用：

:underline:`This text is underlined`

在您的 css 文件中，您可以：

.underline {
  text-decoration: underline;
}

这应该适用于 HTML 输出。然而，下划线故意不属于 ReST 规范的一部分。请参阅此链接。

Answer 2

例如，您在 index.rst 文件中添加以下指令：

.. role:: underline
    :class: underline

在文档中，您使用以下内容指示文本带有下划线：

:underline:`This text is underlined`

要为下划线类指定 css，您可以将一些 css 添加到文件夹 _themes/ 内的布局.html 文件中sphinx_rtd_theme/sphinx_rtd_theme/ 如果您使用的是 sphinx_rtd_theme，否则您的默认主题目录：

<style>
    .underline {
    text-decoration: underline;
  }
</style>

这将相应地设置您的 html 样式。

根据 David Ascher 在其 2000 年 1 月 21 日 Doc-SIG 邮件列表帖子“Docstring 语法：一个非常修订的提案”中的引用，下划线是 StructureText 的一部分，但不是 Sphinx 的 reStructuredText 规范的一部分：

用 _ 标记带下划线的文本不是最理想的。下划线
不应该从印刷的角度使用（下划线是
设计用于手稿中与排字人员沟通
文本应该是斜体——没有一本排版良好的书使用过
下划线），并与双下划线Python变量冲突
名称（init 等），这些名称会被截断并
当不需要这种效果时，会加下划线。请注意，虽然完成
我认为标记会阻止截断（'init'）
文档字符串标记很像我认为的类型注释——它们应该
是可选的，最重要的是没有害处。在这种情况下，下划线
标记确实有害。

Answer 3

如果要标记插入的文本部分，请定义并使用“ins”角色：

.. role:: ins

The "ins" role is by default rendered as underlined :ins:`in HTML5, 
where the <ins> tag is used`.