python - Sphinx autodoc は十分に自動化されていません

Question

Sphinx を使用して、Python で 5,000 行以上のプロジェクトを文書化しようとしています。約 7 つの基本モジュールがあります。私の知る限り、autodoc を使用するには、プロジェクト内の各ファイルに対して次のようなコードを記述する必要があります。

.. automodule:: mods.set.tests
    :members:
    :show-inheritance:

私は多くのファイルを持っているので、これは面倒です。「mods」パッケージを文書化することを指定できれば、はるかに簡単になります。その後、Sphinx はパッケージを再帰的に調べて、各サブモジュールのページを作成できます。

このような機能はありますか？そうでない場合は、すべての .rst ファイルを作成するスクリプトを作成できますが、それには多くの時間がかかります。

Answer 1

私が作成したこのスクリプトを確認できます。私はそれがあなたを助けることができると思います.

このスクリプトは、ディレクトリ ツリーを解析して Python モジュールとパッケージを探し、ReST ファイルを適切に作成して、Sphinx でコード ドキュメントを作成します。また、モジュール インデックスも作成します。

アップデート

このスクリプトはapidocとして Sphinx 1.1 の一部になりました。

Answer 2

各パッケージでは、__init__.pyファイル.. automodule:: package.moduleにパッケージの各部分のコンポーネントを含めることができます。

その後.. automodule:: package、ほとんどの場合、必要なことを実行できます。

Answer 3

おそらく、あなたが探しているのはEpydocとこのSphinx extensionです。