2012-01-31 64 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標記非常類似於我認爲的類型標註 - 它們應該是可選的,並且最重要的是不會造成任何傷害。在這種情況下,下劃線 標記會造成傷害。