問題タブ [sphinx-napoleon]

バージョン 1.3.4の sphinx-doc napoleon Google スタイル docstring の例は、関数/メソッドのオプションの引数を次のように文書化する必要があることを示しています。

しかし、ここのバージョン 1.4a0 の同じページには、同じことを行う次の方法が示されています。

しかし、ドキュメントにはこの新しい構文の説明がありません。sphinx-doc のナポレオン拡張を使用して、Google スタイルの docstring でサポートされている新しい構文に関する詳細情報はどこにありますか?

Numpy スタイルの docstringsを使用して Python プロジェクトのドキュメントを作成しています。

numpydocとnapoleonは、Numpy スタイルの docstring を解析してドキュメントを生成する 2 つの Sphinx 拡張機能です。1 つ目は Numpy プロジェクト自体に使用され、2 つ目は Sphinx に同梱されています。

ある拡張機能を他の拡張機能よりも使用することの長所と短所は何ですか?

Sphinx と Napoleon と autodoc 拡張機能を使用して Google スタイルのドキュメント文字列を解析する Python プロジェクトを文書化しています。Google スタイルでは引数の型を指定する必要があるため、Sphinx は標準ライブラリ内の標準型のドキュメントへのリンクを自動的に作成します。Intersphinx ただし、デフォルトでは 2.7 バージョンのドキュメントにリンクしていますが、私は 3.x バージョンにリンクしたいと考えています。この動作を制御するにはどうすればよいですか?

napoleon_use_ivarオプションを に設定してGoogle docstrings（numpyはテストしていませんが、同様の問題があると思われます）でナポレオンを使用すると、インスタンス変数の名前Trueへのリンクが作成されます。これらの名前は明らかに非常に一般的であり (「名前」など)、ランダムな定義にリンクすることは役に立ちません。これを無効にする方法はありますか?

次のドキュメント文字列が与えられた場合:

namehtml 出力で相互参照を試みます。ターゲットのあいまいさを考えると、これについて不平を言います。

ただし、それでも HTML 出力にリンクが作成されます。属性をクリックするnameと、現在の属性とは関係のないランダムなシンボルに喜んで送信されます。この動作を無効にする方法はありますか?

napoleon_use_ivarがこれに設定されている場合はFalse発生しませんが、属性の出力はまったくコンパクトではなく、非常に読みにくいものです。

これはNapoleon 固有のものではありませんivar。手動で属性を指定すると、制御できない方法で相互参照されます。

それはまだ へのリンクを取得しnameます。

最近、プロジェクトにドキュメントを追加し始め、Google スタイル ガイドに従おうとしています。私は Sphinx を使用してドキュメントを生成し、Sphinx 拡張 napoleon を使用して Google スタイルガイドと reST の間のギャップを埋めています。

パラメータとメモのレンダリングに問題はありませんが、サンプル セクションでコード スニペットをレンダリングできないようです。

例のセクションで二重コロンも試しました。