如何在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，请在文件夹_themes/sphinx_rtd_theme/sphinx_rtd_theme/中的layout.html文件中添加一些css（如果使用的是sphinx_rd_theme），否则您的默认主题目录为：

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

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

根据David Ascher在2000-01-21 Doc SIG邮件列表中的一句话，下划线是StructureText的一部分，但不是Sphinx的reStructuredText规范的一部分："Docstring语法：一个非常修订的建议"：

用_标记带下划线的文本是次优的。下划线不应该从排版的角度使用（下划线设计用于手稿中与排版人员交流文本应该用斜体字——没有一本排版好的书会使用下划线），并与带双下划线的Python变量冲突名称（init等），这些名称将被截断在不希望出现这种效果时加下划线。请注意，完成时标记会阻止截断（'init'），我认为docstring标记很像我认为的类型注释——它们应该是可选的，最重要的是没有伤害。在这种情况下，下划线加价是有害的。