46

Sphinx-Napoleon を使用して、Google スタイルの docstring でリスト、オプションの引数、ジェネレーターの戻り値の型を指定するにはどうすればよいですか?

私はもう試した

List[type]
list of type

Optional[type]
type, optional

Yields:
   type: 

それぞれ; しかし、すべて生成されたドキュメントの残りの部分と一致しない不満足な出力を生成します。例えば

Optional[type]

ただ与える

オプション[タイプ]

のリンクなしtype

すべての組み込みテーマを試しましたが、同じ問題があります。

Sphinx-Napoleon で Google スタイルのドキュメント文字列を使用して、これらの要素をどのように文書化すればよいですか?

4

1 に答える 1