3

sphinx autodocを使用して、複数行の docstring の最初の行を特別な方法でフォーマットする方法はありますか?

検討：

def whatever():
    """This function does something.

    This really should have a full function definition, but I am too lazy.
    Some more stuff.
    """

生成される html コード:

<dd>
<p>This function does something.</p>
<p>This really should have a full function definition, but I am too lazy. Some more stuff.</p>
</dd>

次のようなものにしたい：

<dd>
<p class='headline'>This function does something.</p>
<p>This really should have a full function definition, but I am too lazy. Some more stuff.</p>
</dd>
4

1 に答える 1

4

私の知る限り、autodocには、特にdocstringにカスタムスタイルを追加することに関して、docstringをマークアップする機能はあまりありません。これを回避するには、次の2つの方法が考えられます。1）最初の行を**This function does something**太字にするように折り返します。2）autodocがそれらを解析する前にdocstringをインターセプトするカスタムスフィンクス拡張を記述し、それに応じて物事を壊します。

（ドキュメント文字列にセクションヘッダーを含めるために、オプション2の道を進むことになりました...これがその拡張機能のソースです。必要なことは実行されませんが、特に開始点として役立つ可能性があります。_remove_oneline関数がモジュールdocstringに対して行うこと）。

于 2012-08-18T14:59:24.267 に答える