Napoleon numpy スタイルで文書化されたいくつかの関数を含むプロジェクトがあります。numpyness の精神で、 class の関数引数がたくさんありますarray-like。次に例を示します。

これは問題なく機能し、タイプはリンクなしで出力に含まれます。

問題は、これを持つすべての関数のすべての行で警告が表示されることです:

何らかの解決策があると私はかなり確信しています。PR #7690が何らかの形でこれに対処したようですが、ナポレオンまたはより広範なスフィンクスのドキュメントのどこにも意味のある参照「前処理」が見つかりません。

では、どうすれば警告を取り除くことができますか?

次のような複数の警告が表示されます。

警告: pyfar.signal.TimeData.times の重複したオブジェクト記述、pyfar.classes_audio の他のインスタンス、そのうちの 1 つに :noindex: を使用

しかし、なぜわからないのですか？同じオブジェクトを異なる rst ファイルに 2 回含める可能性があると誰かが提案しました。しかし、私はそうではないと思います。

元のパッケージ ( https://github.com/pyfar/pyfar/tree/develop/docs )に基づいて最小限の作業例を作成しようとしました:

コードを入手する

仮想環境を作る

ドキュメントの構築

収量

返信ありがとうございます、ファビアン

Sphinx autodoc および napoleon 拡張機能を使用して、プロジェクト ( Qtools ) のドキュメントを生成しています。これは私のローカルマシンでうまく機能します。Sphinx 3.1.2 (またはそれ以降) を使用しています。ただし、Read the Docs (RTD) でドキュメントをビルドすると、ドキュメントのソースを形成する reStructuredText ファイルに直接追加されたテキストのみが処理されます。autodoc によって取り込まれるはずの docstring は、 RTD によって生成された HTML ドキュメントには表示されません。たとえば、docs\source\section2_rsdoc.rst次のようなものがあります。

これにより、次の結果が得られます。

応答スペクトル

応答スペクトル クラス

応答スペクトルの作成

qtools.convert2rs(パワー スペクトルを応答スペクトルに変換する)も参照してください。

つまり、すべてのディレクティブは明らかに無視され、他の機能へのハイパーリンクは追加されません。このようないくつかの基本的なガイダンス文書を調べましたが、何が間違っているのかわかりません。RTD は、エラーや警告なしでドキュメントをビルドします。RTD の詳細設定には次のものがあります。

• ドキュメントタイプ: Sphinx HTML
• 要件ファイル: requirements.txt
• Python インタープリター: CPython 3.x
• プロジェクトのインストール: いいえ
• システム パッケージを使用する: いいえ
• Python 構成ファイル: 空白
• PDF ビルドを有効にする: いいえ
• EPUB ビルドを有効にする: いいえ

他の設定には触れていません。

では、 conf.py15 行目の次のバリエーションを試しました: sys.path.insert(0, os.path.abspath('.'))、sys.path.insert(0, os.path.abspath('../..'))および現在のsys.path.insert(0, os.path.abspath('../../..')). それらのどれも違いはありませんでした。

どんな助けにも感謝します！