2012-01-31 87 views

回答

21

我问了类似的问题here。试试这样:

:underline:`This text is underlined` 

在你css文件,你可以有:

.underline { 
    text-decoration: underline; 
} 

这应该HTML输出工作

.. role:: underline 
    :class: underline 

在该文件中,这可以应用如下。但是,下划线故意不属于ReST规范的一部分。见this link

2

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

.. role:: underline 
    :class: underline 

在该文件中您指定的文本与强调如下:

:underline:`This text is underlined` 

要为指定的CSS你的下划线课你添加一些CSS到文件夹_themes/sphinx_rtd_theme/sphinx_rtd_theme//如果你正在使用sphinx_rtd_theme的layout.html文件,否则你的默认主题目录:

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

这将相应地设置你的html风格。

下划线是StructureText的一部分不狮身人面像的新结构化的规格,但据从大卫Ascher的在他2000年1月21日DOC-SIG邮件列表后报价,“文档字符串语法:一个非常修订建议”:

带_的下划线文本标记不理想。下划线 不应该从印刷的角度来使用(下划线是 旨在用于手稿与排字机 沟通文本应斜体 - 没有良好的排版的书有史以来使用 下划线),并与双重冲突-underderscored Python变量 名称(初始值等),当不需要该效果时将被截断,并且下划线为 。请注意,虽然完整的 标记可以防止截断('初始'),但我认为 docstring标记非常类似于我认为的类型标注 - 它们应该是可选的,并且最重要的是不会造成任何伤害。在这种情况下,下划线 标记会造成伤害。