python - スフィンクスのドキュメントにすべてのクラス、メソッド、および関数を自動的に含める方法は?

Question

sphinx と autodoc プラグインを使用して、数千のクラスを含むプロジェクトの HTML ドキュメントを作成しようとしています。sphinx-apidocは素晴らしい rst ファイルを作成しますが、 autoclassesとautomethodsの自動作成が欠けています。

スフィンクスにすべての変数、関数、クラス、およびデコレータをドキュメントに自動的に含める方法/コマンド/ユーティリティはありますか?

1 つの rst ファイルのサンプル コード:

tagger Package
=================

:mod:`tagger` Package
------------------------
.. automodule:: project.tagger
    :members:


:mod:`client` Module
--------------------
.. automodule:: project.analyzers.tagger.client
    :members:

Answer 1

autodocと呼ばれるこの作業に役立つ Sphinx 拡張機能があります。

クラスを含めたい場合は、次のように記述する必要があります。

.. autoclass:: <ClassName>

メソッドの場合も同様です。

.. automethod:: <MethodName>