reStructuredTextのテキストに下線を付けるにはどうすればよいですか？

Question

もちろん、Web上で下線はハイパーリンクを表しますが、ハイパーリンクではない下線が必要な場合はどうすればよいですか？

Answer 1

私は同様の質問をしましたhere。このようにしてみてください。次のように文書で

.. role:: underline 
    :class: underline 

、これを適用することができる：

あなたが持っている可能性があり、あなたの cssファイルで

:underline:`This text is underlined` 

：これは、HTML出力のために働く必要があります

.underline { 
    text-decoration: underline; 
} 

。ただし、アンダーラインは意図的にReST仕様の一部ではありません。 this linkを参照してください。

Answer 2

あなたが例えばindex.rstファイルに次のディレクティブを追加：のCSSを指定するには

:underline:`This text is underlined` 

次の下線として、あなたがテキストを示す文書で

.. role:: underline 
    :class: underline 

を下線クラスでは、sphinx_rtd_themeを使用している場合は_themes/sphinx_rtd_theme/sphinx_rtd_themeフォルダ内のlayout.htmlファイルにCSSを追加します。そうでなければデフォルトテーマディレクトリ：

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

これはあなたのhtmlに応じてスタイルを設定します。

下線は彼の2000年1月21日のDoc-SIGメーリングリストの投稿でデビッド・アッシャーからの引用によると、StructureTextの一部ではなく、スフィンクスのreStructuredTextの仕様であり、「ドキュメンテーション文字列の文法：非常に改訂案」：

_で下線付きのテキストのタグ付けは最適ではありません。下線は、文字の観点からは使用しないでください（下線は、 は、書式に と通信するために使用されました。テキストは斜体にする必要があります。よくタイプセットされた本には 下線を使用しません） Python変数 の名前（initなど）は切り捨てられ、その効果が望ましくない場合は に下線が引かれます。 マークアップが完了すると、その切り捨て（ 'init'）が防止されますが、 docstringマークアップとよく似ています。タイプ注釈と同じように - はオプションで、特に何も問題はありません。この場合、アンダーライン マークアップは危険です。