問題タブ [autodoc]

Sphinxとautodoc 拡張機能を使用して、Python モジュールの API ドキュメントを生成しています。特定のパラメーターを適切に文書化する方法はわかりますが、**kwargsパラメーターを文書化する方法の例を見つけることができません。

これらを文書化する明確な方法の良い例はありますか?

Python プロジェクトの文書化に Sphinx を使用しています。私は autodoc 拡張機能を有効にしており、ドキュメントには次のものがあります。

問題は、クラス内の非プライベート メソッドのみを文書化することです。プライベートメソッドも含めるにはどうすればよいですか?

作業中のPythonモジュールとクラスを文書化するためにSphinxをインストールしました。マークアップ言語は非常に見栄えがしますが、Pythonコードを自動文書化することはできませんでした。

基本的に、私は次のPythonモジュールを持っています：

そしてそれに呼ばれるクラスSeg。生成されたSphinxドキュメント内のクラスとモジュールのドキュメント文字列を表示し、さらにフォーマットされたテキストを追加したいと思います。

私index.rstはこのように見えます：

およびchapter1.rst：

ただしSeg、太字で印刷されているだけで、クラスの自動生成されたドキュメントにはリンクされていません。

次のことも役に立ちませんでした。

編集：SegLibをセグメントに変更し（ありがとう、iElectric！）、chapter1.rstを次のように変更しました：

それでも、Sphinxにクラス内の関数を直接ドキュメント化させることはできません。つまり、クラス内のすべての関数をドキュメントに自動的に追加することはできません。試した：

そして得た：

短いコマンドで関数とクラスを自動文書化する方法はありますか？

Sphinxにはautomethod、メソッドのdocstringからドキュメントを抽出し、それをドキュメントに埋め込むという機能があります。ただし、docstringだけでなく、メソッドのシグネチャ（名前+引数）も埋め込まれます。docstringのみ（メソッドシグネチャを除く）を埋め込むにはどうすればよいですか？

参照：http ：//www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

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

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

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

Sphinx を使用して Python クラスを文書化しようとしています。私は autodoc を使用してそうします:

私のメソッドのdocstringを正しくフェッチしますが、装飾されたものは次のとおりです。

@checkStaleありながら

などの間違ったプロトタイプを持っているopen(*args, **kwargs)。

どうすればこれを修正できますか? @wrapsを使用すると、このようなことが修正されるという印象を受けました。

sphinxのautodoc-skip-memberイベントを使用して、ドキュメント用に特定のpythonクラスのメンバーの一部を選択したいと思います。

しかし、それはスフィンクスのドキュメントからは明らかではなく、私はそれを説明する例を見つけることができません：これを接続するためのコードをどこに置くのですか？Sphinx.connectが表示され、conf.pyに含まれていると思われますが、conf.pyでこのコードのバリエーションを試してみると、connect（）する必要のあるアプリオブジェクトが見つかりません。

簡単な例へのポインタが理想的です。

Sphinxを使用してPythonプロジェクトのドキュメントを自動的に生成しようとしています。モジュールの1つにscipy.signalパッケージが必要です。これは、次を使用してインポートしようとしています。scipy.signalをsignalとしてインポートします。コードは問題なく実行されますが、Sphinxでhtmlを作成すると、セグメンテーション違反が発生します（以下の出力）。ただし、「import scipy as sp」を使用して、sys.pathにscipyディレクトリを配置すると、ドキュメントが問題なく生成されますが、もちろん、コードにそのような機能はありません。必要。

問題を実証するために非常に単純なテストケースを作成し、いくつかのdocstringを使用してテストクラスを作成しました。私はそれを私の.rstと一緒に以下に含めています。「importscipy.signalassignal」という行をコメントアウトすると、すべてが非常にうまく機能します。

scipy.signalをインポートしながら、segの障害を回避する方法についての洞察に感謝します。ローレン

Sphinx出力：

pyexample.py

index.rst

docstrings.rst

私はスフィンクスを使っている初心者です。かなり良さそうです。autodocを使用してほとんどすべてのプロジェクトを文書化しましたが、1つの動作を変更したいと思います。ドキュメントを読んで、私はこれを見ました：autodoc_member_order、そして'bysource'値に変更したい、ポイントは、この値をどこに置くべきかということです。

ありがとう、そして私は私の貧弱な英語をお詫びします。

更新：私はスフィンクス0.6.6を使用しています

Sphinxのautodocプラグインを使用して、モジュールのセットを自動的に文書化します。を受け入れる関数があります。ドキュメントをオーバーライドして、Pythonstdlibドキュメントが使用する*args少し良いスタイルを表示したいと思います。funcname(arg1[, arg2[, ...]])

特定の関数のautodoc出力をオーバーライドすることは可能ですか？