1. ホーム
  2. python

[解決済み] Sphinxのautodocは十分に自動化されていない

2022-05-02 17:02:14

質問

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

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

ファイル数が多いので、これは面倒くさい。mods' パッケージをドキュメント化するように指定できれば、もっと簡単です。そうすれば、Sphinxは再帰的にパッケージを調べて、それぞれのサブモジュールのためのページを作ることができます。

このような機能はあるのでしょうか?なければ、すべての.rstファイルを作成するスクリプトを書くこともできますが、それには多くの時間を取られます。

解決方法は?

こちらをご覧ください。 スクリプト 私が作ったものです。あなたのお役に立てると思います。

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

アップデイト

このスクリプトは現在、Sphinx 1.1 の一部である アピドック .