如何在reStructuredText中加下划线？

Question

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

Answer 1

我问了一个类似的问题here。试试这样：

.. role:: underline
    :class: underline

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

:underline:`This text is underlined`

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

.underline {
  text-decoration: underline;
}

这应该适用于HTML输出。但是，强调是故意不是ReST规范的一部分。请参阅this link。

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_rtd_theme，否则您的默认主题目录为：

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

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

下划线是StructureText的一部分，但不是Sphinx的reStructuredText规范的一部分，根据David Ascher在他的2000-01-21 Doc-SIG邮件列表帖子中的引用，＆＃34; Docstring语法：非常修订提案＆＃34;：

  

使用_＆＃39;标记带下划线的文字不是最理想的。下划线   不应该从排版的角度来使用（强调是   旨在用于手稿与排字机沟通   文本应该用斜体显示 - 没有好的排版书使用过   强调），与双重强调的Python变量冲突   名称（ init 等），这将被截断和   如果不希望这种效果，请加下划线。请注意，虽然完成   我想到，标记会阻止截断（＆＃39; init ＆＃39;）   docstring标记很像我想到的类型注释 - 它们应该   是可选的，最重要的是没有伤害。在这种情况下的下划线   标记确实有害。