python - Sphinx autosummary ディレクティブのこの「生成された」オプションは何ですか?

Question

generated/ライブラリの API を文書化するために sphinx-apidoc と autosummary 拡張機能を使用していますが、以下のオプションの目的を本当に理解できません。

.. autosummary::
   :nosignatures:
   :toctree: generated/

   module.function_1
   module.function_2
   ...

これはSphinxのドキュメントであり、パンダのようなライブラリにあります。私は使用toctreeしていて、API は自動生成されていますが、何が生成されたのかわかりません。生成されたというフォルダーが表示されず、これの利点/目的がわかりません。

ありがとう

Answer 1

「生成された」オプションは、Sphinx が自動的に生成された「スタブ」.rst ファイルを置く出力ディレクトリの名前です。「生成された」と呼ばれる必要はありません。任意の名前を使用できます。

autosummary_generate構成変数が に設定されている場合、Sphinx はディレクティブTrueにリストされている各エントリに対して .rst ファイルを生成します。autosummaryたとえば、複数のクラスを含むモジュールをドキュメント化する場合、この機能を使用して、各クラスの完全なドキュメントを別のページに配置できます。autosummary テーブルには、これらのページへのリンクが含まれます。