問題タブ [autodoc]

Sphinx ドキュメンテーション エンジンは、うまくインポートされないプロジェクトのドキュメンテーションを正常に生成しますか? 特に、私のプロジェクトにはエキゾチックな依存関係があります。ドキュメントの生成をこの依存関係に依存させたくありません。

Sphinx はモジュールをインポートしてイントロスペクションを使用する必要がありますか? それとも解析しますか?

次のドキュメント文字列があります。

sphinx利用可能な場合、パラメータの説明に「デフォルトはX」の部分を追加するように指示する方法はありますか?

次の 2 つのプロパティ定義は、Sphinx autodocHTML 出力でまったく同じように表示されます。

Sphinx には、ある種の識別子で抽象メソッドに注釈を付ける方法がありますか? 私のドキュメントで、私の ABC のどのメンバーを実装する必要があるか、および必要なメンバーが定義された後に取得できる mixin 景品がどれかを明確にしたいと思います。

autodoc の使用方法

プロジェクトの両方で python setup.py を実行しましたが、それらの名前空間はインポート可能です..

私は試した：

しかし、私は得ているだけです

私は何を間違えましたか？

私は単一の .py モジュールしか持たない Python ライブラリに取り組んでおり、docstring からそのドキュメントを生成しようとしています。Sphinx をセットアップして、spinx-quickstart スクリプトを実行しましたが、実行しようとすると (docs ディレクトリで)

しかし、それはただ言う：

単一のファイルを autodoc する他の Sphinx スクリプトはありますか? 実行することだけを考え..ましたが、テストディレクトリに実行され、単体テストからドキュメントを生成しようとすると考えました...

これは私のファイル階層です:

インフォレスキュー
|
|_ src
|
|_ _ _ には
|が含まれます。
|_ _ _ _ _ i1.py
|_ _ _ _ _ i2.py
| _ _ _ _ _ init.py
|
|_ _ _ ユーティリティ
|
|_ _ _ _ _ u1.py
|_ _ _ _ _ u2.py
|_ _ _ _ _ init .py
|
|_ _ _ ドキュメント
|
|_ _ _ _ _ index.rst
|_ _ _ _ _ project.rst
|_ _ _ _ _ contact.rst |_
_ _ _ _ api
|
|_ _ _ _ _ _ api.rst
|_ _ _ _ _ _ includes.rst
|_ _ _ _ _ _ utils.rst

ドキュメントの生成には Sphinx を使用しています。sphinx に関連するものはすべてdocディレクトリにあります。

私のindex.rst：

api.rst :

現在、utils 内には .py ファイルがあります。これらのファイルにはどちらもクラスと直接コードは含まれておらず、関数のみが含まれています。私が使用できる関数を文書化するには.. autofunction:: utils.u1.functionName. これは正しく機能していますが、関数ごとにこのように書く必要があります。すべての機能を単純に含める簡単な方法はありますか?

includesディレクトリ内の両方のファイルにクラスが含まれておらず、一部の（直接）コードのみが機能するとします。そのためのドキュメントを生成する方法、つまりどの自動ディレクティブを使用するか?

また、utils および includes ディレクトリ内のinit .py ファイルは両方とも空です。.rst ファイルからこれらのディレクトリ内のファイルにアクセスできるように、これら 2 つを作成しました。_ init _.py ファイルを作成する必要がないように、他のアプローチはありますか?

この質問は、Mayavi のドキュメントに触発されたものです。このドキュメントには、各モジュール メンバー間で説明されている関数の名前を含む適切なセクション区切りがあります。

私.rstの今は次のようになります：

(すべてのドキュメント形式のテキストがモジュール自体に含まれています。)

の各メンバー間にセクション ヘッダーを挿入したいことを示す簡単な方法はあり:members:ますか? そうでない場合、Mayavi の人々はどのようにそれを行ったのですか?