0

sphinx 3.1.1 を使用して、napoleon プリプロセッサを使用して画像を挿入したいと考えています。

docstring に ".. image::" というコマンドを含めることで、ナポレオン プリプロセッサによる事前解釈が防止され、docstring は標準の sphinx インタープリターによって解釈されるようです。

"""Func

   Args:
       var1 (number): description 1.
       var2 (string): description 2.

   Returns:
       string: description 3.

.. image:: /_images/test.png
   :width: 100
"""

画像は正しく視覚化されていますが、パラメーターと戻り値が正しく解釈されず、プレーン テキストのように見えます。

ここに画像の説明を入力

image コマンドを削除すると、期待どおりの解釈が得られます。

"""Func

   Args:
       var1 (number): description 1.
       var2 (string): description 2.

   Returns:
       string: description 3.
"""

ここに画像の説明を入力

誰にも解決策がありますか?

注意: スフィンクス標準の reStructuredText でドキュメントを書きたくありません。

4

1 に答える 1